COcommpeak
SIP-Accounts

Get a SIP account

Returns one SIP account of the customer by its id (display token), with its settings, authentication and the Dynamic Caller ID rules assigned to it. Deleted accounts and accounts of other customers return 404.

get/sip_accounts/{id}

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/sip_accounts/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

SIP account display token.

Response

Successful Response

Example response

{
  "sip_account": {
    "active": true,
    "auth_method": "password",
    "auto_nat_fix": true,
    "caller_id_fixing": false,
    "channel_limit": 3,
    "default_tech_prefix": "021001",
    "dynamic_caller_ids": [
      12
    ],
    "editable": true,
    "id": "2BZgTQS4X0qaUEHt4YF-oQ",
    "ip_acl": [
      "192.0.2.10"
    ],
    "jwt_enabled": false,
    "name": "demo",
    "out_of_balance_message": true,
    "username": "demo"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.