COconnexcs
Setup SIP Profile

Read

Changed on

Retrieve a single Setup SIP Profile record by ID.

get/api/cp/setup/sip-profile/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

account_idinteger

Account Id (references account.id)

namestring

Name

webphone_licenceinteger

Webphone Licence

flagsstring

Flags

profile_capacityinteger

Profile Capacity

barge_groupstring

Barge Group

pbx_serverstring

Pbx Server

Example response

{
  "id": 12345,
  "account_id": 1,
  "name": "Example Name",
  "webphone_licence": 123,
  "flags": "example_flags",
  "profile_capacity": 123,
  "barge_group": "example_barge_group",
  "pbx_server": "example_pbx_server"
}

Changes

  • f5199a70325aRevision changes
    • info

      added the optional property to the response with the status

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API