Skip to content

Removes numbers from an outbound calling campaign

Method delete.auto_call_campaign_phone_numbers
Description Removes numbers from an outbound calling campaign
Available to Agent, Client

Request parameters

Name Type Required Description
access_token string yes Authentication session key
user_id number no Unique user identifier of the agent client on behalf of which the request is made
Is required for the agent
campaign_id number yes Unique outbound calling campaign identifier
phone_numbers array of string yes List of subscriber numbers

Numbers with any of the following final processing statuses cannot be deleted:

  • successfully_processed
  • processed_outside_campaign
  • deleted

JSON request structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "delete.auto_call_campaign_phone_numbers",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "campaign_id": "number",
    "phone_numbers": ["string"]
  }
}

JSON response structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "success": true
  }
}

List of returned errors

See the section "List of errors for methods with the verb delete"