COcommpeak
SIP-Accounts

List the customer's SIP accounts

Returns all SIP accounts of the customer that have not been deleted. Each account is identified by its id (display token) and shows its name, authentication method — password (with username) or ip (with the list of authorized auth_ips) — and the concurrent channel limit. active is false while the account has not yet been created in the billing system and cannot place calls. The id can be used to filter outbound call records by SIP account.

get/sip_accounts

Request

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

Response

Successful Response

Example response

{
  "sip_accounts": [
    {
      "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.