{
  "info": {
    "_postman_id": "aabd8d71-7db6-4d9d-b60a-01b20e7e023e",
    "name": "RingCentral Adaptive Cards Device SIP Registration API",
    "description": "RingCentral API specification\n\nContact Support:\n Name: RingCentral Developers Support",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T02:49:20.000Z",
    "updatedAt": "2026-07-28T02:49:20.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-aabd8d71-7db6-4d9d-b60a-01b20e7e023e"
  },
  "item": [
    {
      "name": "restapi",
      "item": [
        {
          "name": "v1.0",
          "item": [
            {
              "name": "client-info",
              "item": [
                {
                  "name": "sip-provision",
                  "item": [
                    {
                      "name": "Register Device",
                      "id": "55459847-2390-4441-9526-5ccd204bba1d",
                      "protocolProfileBehavior": {
                        "disableBodyPruning": true
                      },
                      "request": {
                        "method": "POST",
                        "header": [
                          {
                            "key": "Content-Type",
                            "value": "application/json"
                          },
                          {
                            "key": "Accept",
                            "value": "application/json"
                          }
                        ],
                        "body": {
                          "mode": "raw",
                          "raw": "{\n  \"device\": {\n    \"id\": \"<string>\",\n    \"appExternalId\": \"<string>\",\n    \"computerName\": \"<string>\",\n    \"serial\": \"<string>\"\n  },\n  \"sipInfo\": [\n    {\n      \"transport\": \"UDP\"\n    },\n    {\n      \"transport\": \"WSS\"\n    }\n  ],\n  \"softPhoneLineReassignment\": \"None\"\n}",
                          "options": {
                            "raw": {
                              "headerFamily": "json",
                              "language": "json"
                            }
                          }
                        },
                        "url": {
                          "raw": "{{baseUrl}}/restapi/v1.0/client-info/sip-provision",
                          "host": [
                            "{{baseUrl}}"
                          ],
                          "path": [
                            "restapi",
                            "v1.0",
                            "client-info",
                            "sip-provision"
                          ]
                        },
                        "description": "Creates SIP registration of a device/application (WebPhone, Mobile, Softphone).\n"
                      },
                      "response": [
                        {
                          "id": "6019769d-6241-49e6-880e-d2c7cd897fe9",
                          "name": "Success",
                          "originalRequest": {
                            "method": "POST",
                            "header": [
                              {
                                "key": "Content-Type",
                                "value": "application/json"
                              },
                              {
                                "key": "Accept",
                                "value": "application/json"
                              },
                              {
                                "description": "Added as a part of security scheme: oauth2",
                                "key": "Authorization",
                                "value": "<token>"
                              }
                            ],
                            "body": {
                              "mode": "raw",
                              "raw": "{\n  \"device\": {\n    \"id\": \"<string>\",\n    \"appExternalId\": \"<string>\",\n    \"computerName\": \"<string>\",\n    \"serial\": \"<string>\"\n  },\n  \"sipInfo\": [\n    {\n      \"transport\": \"UDP\"\n    },\n    {\n      \"transport\": \"WSS\"\n    }\n  ],\n  \"softPhoneLineReassignment\": \"None\"\n}",
                              "options": {
                                "raw": {
                                  "headerFamily": "json",
                                  "language": "json"
                                }
                              }
                            },
                            "url": {
                              "raw": "{{baseUrl}}/restapi/v1.0/client-info/sip-provision",
                              "host": [
                                "{{baseUrl}}"
                              ],
                              "path": [
                                "restapi",
                                "v1.0",
                                "client-info",
                                "sip-provision"
                              ]
                            }
                          },
                          "status": "OK",
                          "code": 200,
                          "_postman_previewlanguage": "json",
                          "header": [
                            {
                              "key": "Content-Type",
                              "value": "application/json"
                            }
                          ],
                          "cookie": [],
                          "responseTime": null,
                          "body": "{\n  \"device\": {\n    \"uri\": \"<uri>\",\n    \"id\": \"<string>\",\n    \"type\": \"Room\",\n    \"sku\": \"<string>\",\n    \"status\": \"Offline\",\n    \"name\": \"<string>\",\n    \"serial\": \"<string>\",\n    \"computerName\": \"<string>\",\n    \"model\": {\n      \"addons\": [\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"count\": \"<integer>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"count\": \"<integer>\"\n        }\n      ],\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"features\": [\n        \"HELD\",\n        \"Intercom\"\n      ]\n    },\n    \"extension\": {\n      \"id\": \"<long>\",\n      \"uri\": \"<uri>\",\n      \"extensionNumber\": \"<string>\"\n    },\n    \"emergencyServiceAddress\": {\n      \"street\": \"<string>\",\n      \"street2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"customerName\": \"<string>\",\n      \"state\": \"<string>\",\n      \"stateId\": \"<string>\",\n      \"stateIsoCode\": \"<string>\",\n      \"stateName\": \"<string>\",\n      \"countryId\": \"<string>\",\n      \"countryIsoCode\": \"<string>\",\n      \"country\": \"<string>\",\n      \"countryName\": \"<string>\",\n      \"outOfCountry\": \"<boolean>\"\n    },\n    \"emergency\": {\n      \"address\": {\n        \"street\": \"<string>\",\n        \"street2\": \"<string>\",\n        \"city\": \"<string>\",\n        \"zip\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"state\": \"<string>\",\n        \"stateId\": \"<string>\",\n        \"stateIsoCode\": \"<string>\",\n        \"stateName\": \"<string>\",\n        \"countryId\": \"<string>\",\n        \"countryIsoCode\": \"<string>\",\n        \"country\": \"<string>\",\n        \"countryName\": \"<string>\",\n        \"outOfCountry\": \"<boolean>\"\n      },\n      \"location\": {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"addressFormatId\": \"<string>\"\n      },\n      \"outOfCountry\": \"<boolean>\",\n      \"addressStatus\": \"Invalid\",\n      \"visibility\": \"Public\",\n      \"syncStatus\": \"Failed\",\n      \"addressEditableStatus\": \"AnyDevice\",\n      \"addressRequired\": \"<boolean>\",\n      \"addressLocationOnly\": \"<boolean>\"\n    },\n    \"shipping\": {\n      \"status\": \"Accepted\",\n      \"carrier\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"method\": {\n        \"id\": \"1\",\n        \"name\": \"Ground\"\n      },\n      \"address\": {\n        \"customerName\": \"<string>\",\n        \"additionalCustomerName\": \"<string>\",\n        \"customerEmail\": \"<email>\",\n        \"additionalCustomerEmail\": \"<email>\",\n        \"customerPhone\": \"<string>\",\n        \"additionalCustomerPhone\": \"<string>\",\n        \"street\": \"<string>\",\n        \"street2\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"stateId\": \"<string>\",\n        \"stateIsoCode\": \"<string>\",\n        \"stateName\": \"<string>\",\n        \"countryId\": \"<string>\",\n        \"countryIsoCode\": \"<string>\",\n        \"country\": \"<string>\",\n        \"countryName\": \"<string>\",\n        \"zip\": \"<string>\",\n        \"taxId\": \"<string>\"\n      }\n    },\n    \"phoneLines\": [\n      {\n        \"id\": \"<string>\",\n        \"lineType\": \"StandaloneFree\",\n        \"emergencyAddress\": {\n          \"required\": \"<boolean>\",\n          \"localOnly\": \"<boolean>\"\n        },\n        \"phoneInfo\": {\n          \"id\": \"<long>\",\n          \"country\": {\n            \"id\": \"<string>\",\n            \"uri\": \"<uri>\",\n            \"name\": \"<string>\"\n          },\n          \"paymentType\": \"External\",\n          \"phoneNumber\": \"<string>\",\n          \"usageType\": \"ForwardedCompanyNumber\",\n          \"type\": \"VoiceFax\"\n        }\n      },\n      {\n        \"id\": \"<string>\",\n        \"lineType\": \"StandaloneFree\",\n        \"emergencyAddress\": {\n          \"required\": \"<boolean>\",\n          \"localOnly\": \"<boolean>\"\n        },\n        \"phoneInfo\": {\n          \"id\": \"<long>\",\n          \"country\": {\n            \"id\": \"<string>\",\n            \"uri\": \"<uri>\",\n            \"name\": \"<string>\"\n          },\n          \"paymentType\": \"Local\",\n          \"phoneNumber\": \"<string>\",\n          \"usageType\": \"ContactCenterNumber\",\n          \"type\": \"FaxOnly\"\n        }\n      }\n    ],\n    \"boxBillingId\": \"<long>\",\n    \"useAsCommonPhone\": \"<boolean>\",\n    \"linePooling\": \"Host\",\n    \"inCompanyNet\": \"<boolean>\",\n    \"site\": {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"lastLocationReportTime\": \"<dateTime>\"\n  },\n  \"sipFlags\": {\n    \"voipFeatureEnabled\": \"<boolean>\",\n    \"voipCountryBlocked\": \"<boolean>\",\n    \"outboundCallsEnabled\": \"<boolean>\",\n    \"dscpEnabled\": \"<boolean>\",\n    \"dscpSignaling\": \"<integer>\",\n    \"dscpVoice\": \"<integer>\",\n    \"dscpVideo\": \"<integer>\"\n  },\n  \"sipInfo\": [\n    {\n      \"username\": \"<string>\",\n      \"password\": \"<string>\",\n      \"authorizationTypes\": [\n        \"BearerToken\",\n        \"SipDigest\"\n      ],\n      \"authorizationId\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"outboundProxy\": \"<string>\",\n      \"outboundProxyIPv6\": \"<string>\",\n      \"outboundProxyBackup\": \"<string>\",\n      \"outboundProxyIPv6Backup\": \"<string>\",\n      \"transport\": \"TCP\",\n      \"certificate\": \"<string>\",\n      \"switchBackInterval\": \"<integer>\",\n      \"stunServers\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    },\n    {\n      \"username\": \"<string>\",\n      \"password\": \"<string>\",\n      \"authorizationTypes\": [\n        \"BearerToken\",\n        \"SipDigest\"\n      ],\n      \"authorizationId\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"outboundProxy\": \"<string>\",\n      \"outboundProxyIPv6\": \"<string>\",\n      \"outboundProxyBackup\": \"<string>\",\n      \"outboundProxyIPv6Backup\": \"<string>\",\n      \"transport\": \"TLS\",\n      \"certificate\": \"<string>\",\n      \"switchBackInterval\": \"<integer>\",\n      \"stunServers\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    }\n  ],\n  \"sipInfoPstn\": [\n    {\n      \"username\": \"<string>\",\n      \"password\": \"<string>\",\n      \"authorizationTypes\": [\n        \"BearerToken\",\n        \"SipDigest\"\n      ],\n      \"authorizationId\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"outboundProxy\": \"<string>\",\n      \"outboundProxyIPv6\": \"<string>\",\n      \"outboundProxyBackup\": \"<string>\",\n      \"outboundProxyIPv6Backup\": \"<string>\",\n      \"transport\": \"WSS\",\n      \"certificate\": \"<string>\",\n      \"switchBackInterval\": \"<integer>\",\n      \"stunServers\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    },\n    {\n      \"username\": \"<string>\",\n      \"password\": \"<string>\",\n      \"authorizationTypes\": [\n        \"BearerToken\",\n        \"SipDigest\"\n      ],\n      \"authorizationId\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"outboundProxy\": \"<string>\",\n      \"outboundProxyIPv6\": \"<string>\",\n      \"outboundProxyBackup\": \"<string>\",\n      \"outboundProxyIPv6Backup\": \"<string>\",\n      \"transport\": \"UDP\",\n      \"certificate\": \"<string>\",\n      \"switchBackInterval\": \"<integer>\",\n      \"stunServers\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    }\n  ],\n  \"sipErrorCodes\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"pollingInterval\": \"<integer>\"\n}",
                          "createdAt": "2026-07-28T02:49:21.000Z",
                          "updatedAt": "2026-07-28T02:49:21.000Z",
                          "uid": "35240-6019769d-6241-49e6-880e-d2c7cd897fe9"
                        },
                        {
                          "id": "401206a7-058f-4fb6-8b89-271d033f5085",
                          "name": "General response with **HTTP 400 \"Bad request\"** status.<br>\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n",
                          "originalRequest": {
                            "method": "POST",
                            "header": [
                              {
                                "key": "Content-Type",
                                "value": "application/json"
                              },
                              {
                                "key": "Accept",
                                "value": "application/json"
                              },
                              {
                                "description": "Added as a part of security scheme: oauth2",
                                "key": "Authorization",
                                "value": "<token>"
                              }
                            ],
                            "body": {
                              "mode": "raw",
                              "raw": "{\n  \"device\": {\n    \"id\": \"<string>\",\n    \"appExternalId\": \"<string>\",\n    \"computerName\": \"<string>\",\n    \"serial\": \"<string>\"\n  },\n  \"sipInfo\": [\n    {\n      \"transport\": \"UDP\"\n    },\n    {\n      \"transport\": \"WSS\"\n    }\n  ],\n  \"softPhoneLineReassignment\": \"None\"\n}",
                              "options": {
                                "raw": {
                                  "headerFamily": "json",
                                  "language": "json"
                                }
                              }
                            },
                            "url": {
                              "raw": "{{baseUrl}}/restapi/v1.0/client-info/sip-provision",
                              "host": [
                                "{{baseUrl}}"
                              ],
                              "path": [
                                "restapi",
                                "v1.0",
                                "client-info",
                                "sip-provision"
                              ]
                            }
                          },
                          "status": "Bad Request",
                          "code": 400,
                          "_postman_previewlanguage": "json",
                          "header": [
                            {
                              "key": "Content-Type",
                              "value": "application/json"
                            }
                          ],
                          "cookie": [],
                          "responseTime": null,
                          "body": "{\n  \"errors\": [\n    {\n      \"errorCode\": \"<string>\",\n      \"message\": \"<string>\",\n      \"parameterName\": \"<string>\",\n      \"parameterValue\": \"<string>\"\n    }\n  ]\n}",
                          "createdAt": "2026-07-28T02:49:21.000Z",
                          "updatedAt": "2026-07-28T02:49:21.000Z",
                          "uid": "35240-401206a7-058f-4fb6-8b89-271d033f5085"
                        },
                        {
                          "id": "27ca09d7-37b9-4426-838f-387b1b7e235f",
                          "name": "General response with **HTTP 500 \"Internal Server Error\"** status.<br>\nReasons: general server-side error.\n",
                          "originalRequest": {
                            "method": "POST",
                            "header": [
                              {
                                "key": "Content-Type",
                                "value": "application/json"
                              },
                              {
                                "key": "Accept",
                                "value": "application/json"
                              },
                              {
                                "description": "Added as a part of security scheme: oauth2",
                                "key": "Authorization",
                                "value": "<token>"
                              }
                            ],
                            "body": {
                              "mode": "raw",
                              "raw": "{\n  \"device\": {\n    \"id\": \"<string>\",\n    \"appExternalId\": \"<string>\",\n    \"computerName\": \"<string>\",\n    \"serial\": \"<string>\"\n  },\n  \"sipInfo\": [\n    {\n      \"transport\": \"UDP\"\n    },\n    {\n      \"transport\": \"WSS\"\n    }\n  ],\n  \"softPhoneLineReassignment\": \"None\"\n}",
                              "options": {
                                "raw": {
                                  "headerFamily": "json",
                                  "language": "json"
                                }
                              }
                            },
                            "url": {
                              "raw": "{{baseUrl}}/restapi/v1.0/client-info/sip-provision",
                              "host": [
                                "{{baseUrl}}"
                              ],
                              "path": [
                                "restapi",
                                "v1.0",
                                "client-info",
                                "sip-provision"
                              ]
                            }
                          },
                          "status": "Internal Server Error",
                          "code": 500,
                          "_postman_previewlanguage": "json",
                          "header": [
                            {
                              "key": "Content-Type",
                              "value": "application/json"
                            }
                          ],
                          "cookie": [],
                          "responseTime": null,
                          "body": "{\n  \"errors\": [\n    {\n      \"errorCode\": \"<string>\",\n      \"message\": \"<string>\"\n    }\n  ]\n}",
                          "createdAt": "2026-07-28T02:49:21.000Z",
                          "updatedAt": "2026-07-28T02:49:21.000Z",
                          "uid": "35240-27ca09d7-37b9-4426-838f-387b1b7e235f"
                        },
                        {
                          "id": "1ff8c828-f70e-447d-af50-dd6c35262639",
                          "name": "General response with **HTTP 503 \"Service not available\"** status.<br>\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n",
                          "originalRequest": {
                            "method": "POST",
                            "header": [
                              {
                                "key": "Content-Type",
                                "value": "application/json"
                              },
                              {
                                "key": "Accept",
                                "value": "application/json"
                              },
                              {
                                "description": "Added as a part of security scheme: oauth2",
                                "key": "Authorization",
                                "value": "<token>"
                              }
                            ],
                            "body": {
                              "mode": "raw",
                              "raw": "{\n  \"device\": {\n    \"id\": \"<string>\",\n    \"appExternalId\": \"<string>\",\n    \"computerName\": \"<string>\",\n    \"serial\": \"<string>\"\n  },\n  \"sipInfo\": [\n    {\n      \"transport\": \"UDP\"\n    },\n    {\n      \"transport\": \"WSS\"\n    }\n  ],\n  \"softPhoneLineReassignment\": \"None\"\n}",
                              "options": {
                                "raw": {
                                  "headerFamily": "json",
                                  "language": "json"
                                }
                              }
                            },
                            "url": {
                              "raw": "{{baseUrl}}/restapi/v1.0/client-info/sip-provision",
                              "host": [
                                "{{baseUrl}}"
                              ],
                              "path": [
                                "restapi",
                                "v1.0",
                                "client-info",
                                "sip-provision"
                              ]
                            }
                          },
                          "status": "Service Unavailable",
                          "code": 503,
                          "_postman_previewlanguage": "json",
                          "header": [
                            {
                              "key": "Content-Type",
                              "value": "application/json"
                            }
                          ],
                          "cookie": [],
                          "responseTime": null,
                          "body": "{\n  \"errors\": [\n    {\n      \"errorCode\": \"<string>\",\n      \"message\": \"<string>\"\n    }\n  ]\n}",
                          "createdAt": "2026-07-28T02:49:21.000Z",
                          "updatedAt": "2026-07-28T02:49:21.000Z",
                          "uid": "35240-1ff8c828-f70e-447d-af50-dd6c35262639"
                        }
                      ],
                      "createdAt": "2026-07-28T02:49:21.000Z",
                      "updatedAt": "2026-07-28T02:49:21.000Z",
                      "uid": "35240-55459847-2390-4441-9526-5ccd204bba1d"
                    }
                  ],
                  "id": "a6a5d2a0-beaa-4798-a3f1-ca9bfc162e62",
                  "createdAt": "2026-07-28T02:49:21.000Z",
                  "updatedAt": "2026-07-28T02:49:21.000Z",
                  "uid": "35240-a6a5d2a0-beaa-4798-a3f1-ca9bfc162e62"
                }
              ],
              "id": "e9803242-b525-4415-a0e2-95e5ea95614b",
              "createdAt": "2026-07-28T02:49:21.000Z",
              "updatedAt": "2026-07-28T02:49:21.000Z",
              "uid": "35240-e9803242-b525-4415-a0e2-95e5ea95614b"
            }
          ],
          "id": "18f3d5a8-cd46-4ce2-899f-a813c9c30376",
          "createdAt": "2026-07-28T02:49:21.000Z",
          "updatedAt": "2026-07-28T02:49:21.000Z",
          "uid": "35240-18f3d5a8-cd46-4ce2-899f-a813c9c30376"
        }
      ],
      "id": "07d1f4f5-e5eb-4255-bd77-96904be42125",
      "createdAt": "2026-07-28T02:49:21.000Z",
      "updatedAt": "2026-07-28T02:49:21.000Z",
      "uid": "35240-07d1f4f5-e5eb-4255-bd77-96904be42125"
    }
  ],
  "auth": {
    "type": "oauth2",
    "oauth2": [
      {
        "key": "redirect_uri",
        "value": "https://platform.ringcentral.com/restapi/oauth/token",
        "type": "string"
      },
      {
        "key": "accessTokenUrl",
        "value": "https://platform.ringcentral.com/restapi/oauth/token",
        "type": "string"
      },
      {
        "key": "authUrl",
        "value": "https://platform.ringcentral.com/restapi/oauth/authorize",
        "type": "string"
      },
      {
        "key": "grant_type",
        "value": "authorization_code",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://platform.ringcentral.com"
    }
  ]
}