[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-voximplant-sip\u002Fget":3,"docs-tabs-voximplant-sip\u002Fget":6},{"content":4,"lastmod":5},"## Get connection\n\n`GET \u002Fv1\u002Fvoximplant-sip\u002F:configId`\n\nReturns an office or cloud PBX SIP connection by ID — for example, to check the registration on the SIP server after creating the connection.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `configId` (path) | number | yes | Connection ID. List: [`GET \u002Fv1\u002Fvoximplant-sip`](\u002Fdocs\u002Fvoximplant-sip\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fvoximplant-sip\u002F17\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fvoximplant-sip\u002F17\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fvoximplant-sip\u002F17', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nif (success) {\n  console.log(data.title, data.server, 'password set:', data.hasPassword)\n}\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fvoximplant-sip\u002F17', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\nif (success) {\n  console.log(data.title, data.server, 'password set:', data.hasPassword)\n}\n```\n\n## Response fields\n\nPasswords are not returned — the response carries the `hasPassword` and `hasIncomingPassword` flags instead.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data` | object | The SIP connection. Its fields are the `data.*` rows below |\n| `data.configId` | string | Connection ID |\n| `data.type` | string | PBX type: `office` — office PBX, `cloud` — cloud PBX |\n| `data.title` | string | Connection name |\n| `data.server` | string | SIP server address |\n| `data.login` | string | Login on the SIP server |\n| `data.hasPassword` | boolean | Whether the connection password is set |\n| `data.authUser` | string \\| null | User name for authorization on the SIP server. `null` if not set |\n| `data.outboundProxy` | string \\| null | Proxy server address for outgoing calls. `null` if not set |\n| `data.detectLineNumber` | string | Whether to detect the line number from the SIP headers of an incoming call: `N` — do not detect |\n| `data.lineDetectHeaderOrder` | string | SIP headers used to detect the line number, in the order they are checked, for example `diversion;to` |\n| `data.registrationStatusCode` | string \\| null | Result code of the registration on the SIP server, for example `502` when the server is not found |\n| `data.registrationErrorMessage` | string \\| null | Registration error text. `null` if there is no error |\n| `data.regId` | string | Cloud PBX only: registration ID on the SIP server |\n| `data.incomingServer` | string | Office PBX only: server address for incoming calls, issued by Bitrix24 |\n| `data.incomingLogin` | string | Office PBX only: login for incoming calls, issued by Bitrix24 |\n| `data.hasIncomingPassword` | boolean | Office PBX only: whether the password for incoming calls is set |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"type\": \"office\",\n    \"configId\": \"17\",\n    \"server\": \"sip.example.com\",\n    \"login\": \"office-line\",\n    \"hasPassword\": true,\n    \"incomingServer\": \"ip.b24-1234-1234567890.bitrixphone.com\",\n    \"incomingLogin\": \"sip17\",\n    \"hasIncomingPassword\": true,\n    \"authUser\": null,\n    \"outboundProxy\": null,\n    \"detectLineNumber\": \"N\",\n    \"lineDetectHeaderOrder\": \"diversion;to\",\n    \"registrationStatusCode\": \"0\",\n    \"registrationErrorMessage\": null,\n    \"title\": \"Office PBX\"\n  }\n}\n```\n\n## Error response example\n\n404 — connection not found:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"SIP connection not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | `configId` is not a positive integer |\n| 404 | `ENTITY_NOT_FOUND` | No connection with this `configId` among the connections available to the key |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not passed |\n| 401 | `INVALID_API_KEY` | The platform does not know this key string: a typo, a truncated value or a deleted key |\n| 401 | `TOKEN_MISSING` | The key has no access to the portal: a personal key has no portal webhook, or an application key was sent without a session token in `Authorization: Bearer` |\n| 403 | `SCOPE_DENIED` | The key does not have the `telephony` scope |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access — [causes explained](\u002Fdocs\u002Ferrors\u002Fauth#bitrix_access_denied-403) |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the request. The reason is in `error.message` |\n| 429 | `RATE_LIMITED` | Request rate limit exceeded |\n| 429 | `QUEUE_OVERFLOW` | The account request queue is full, so the request is rejected without waiting. The `Retry-After` header suggests the delay |\n| 429 | `QUEUE_TIMEOUT` | The request did not get through the account queue in time and was not sent to Bitrix24. The `Retry-After` header suggests the delay |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable |\n| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n- **Only connections of the key's own application are visible.** The method finds a connection only if it was created by the same Bitrix24 application as the key: an application key sees the connections of its own application, a personal key sees the connections created through the Bitrix24 account's webhooks. For the `configId` of another application's connection, the method responds with `404 ENTITY_NOT_FOUND`.\n\n## See also\n\n- [List connections](\u002Fdocs\u002Fvoximplant-sip\u002Flist)\n- [Update connection](\u002Fdocs\u002Fvoximplant-sip\u002Fupdate)\n- [Delete connection](\u002Fdocs\u002Fvoximplant-sip\u002Fdelete)\n- [SIP connections](\u002Fdocs\u002Fvoximplant-sip)\n","2026-10-13",{},1795377199339]