Contacts API

Use the Contacts API to request the list of contacts on the VoIP account.

API calls

Click on each call to view the endpoint, method, and request example.

List the registered contacts

Returns the contact list for the account.

Method and endpoint

GET /v2/accounts/{ACCOUNT_ID}/contact_list

Request

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    https://apps.hostedpbx.ie:8443/v2/accounts/{ACCOUNT_ID}/contact_list

Response

  {
      "auth_token": "{AUTH_TOKEN}",
      "data": [
          {
              "external_number": "+14157775555",
              "internal_number": "1000",
              "name": "John Quux"
          }
      ],
      "request_id": "{REQUEST_ID}",
      "revision": "{REVISION}",
      "status": "success"
  }