DIDs

Activate or deactivate dynamic caller ids

Activate or deactivate one or more dynamic caller IDs in a single request.

Parameters.

  • is_active (integer, required): Status to set. 1 to activate, 0 to deactivate.
  • ids (array of integers, required): IDs of the dynamic caller IDs to update.

Returns. { "updatedIds": [ ... ] }, listing the IDs that were changed.

Notes. A caller ID that is set as a campaign's default caller ID is skipped when deactivating, so it will not appear in updatedIds. Any IDs that do not exist are ignored.

Example.

POST /api/did
{
  "is_active": 0,
  "ids": [15, 11]
}
post/{sub_domain}/api/did

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/did
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

is_activeinteger required

Status to set. 0 to deactivate, 1 to activate.

idsinteger[] required

IDs of the dynamic caller ids to update.

Response

Successful Response

updatedIdsinteger[] required

IDs of the dynamic caller ids that were updated.

Changes

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