Add numbers
/v1/accounts/{accountId}/campaigns/{campaignId}/numbersAdds one or more numbers to a campaign, with their variable values.
Numbers can be added to campaigns in Draft state, and to Active or Paused campaigns with Dynamic number provisioning. Other campaigns return 409 Conflict.
Duplicates are handled differently depending on the state of the campaign. In Draft campaigns, a number with the same variable values as an existing one is skipped (the same number can be added again with different values). In Active or Paused campaigns, every number sent is added, even if it already exists, since it's considered a new call to make, for example to contact the same customer again.
Path parameters
ID of your SIP Caller account. See Account ID.
ID of the campaign.
Query parameters
Names of the variables whose values are sent in varValues, in the same order, such as ["Customer Name","Due Balance"]. Each name must start with a letter, and contain only letters, digits, spaces and underscores, up to 255 characters.
The first numbers added to the campaign define its variable names: if varNames is omitted at that point, they're named Var1, Var2, and so on. Later requests must send the same number of variable values, and if varNames is included, the names must match the existing ones.
Request body
A JSON array of objects, one for each number to add. A single object is also accepted.
Phone number to call. Separators such as spaces, dashes, dots and parentheses are allowed and removed, for example +1 (555) 123-9000. The number must contain between 3 and 50 digits, and can end with p followed by DTMF digits to dial after the call is answered, such as +15551239000p123. Up to 15 numbers can be specified for the same contact, separated by semicolons (;).
Values of the variables for this number, used to personalize the call flow prompts or the AI agent conversation. All the numbers of the request must have the same number of values, matching the variables of the campaign. Defaults to an empty array.
Returns
Returns an array with the campaign number objects added. Skipped duplicates are not included, so the array is empty if all the numbers were duplicated.
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers?varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
{
"number": "+18005551234",
"varValues": [
"John Carter",
"$199.00"
]
},
{
"number": "+18005551235",
"varValues": [
"Jane Miller",
"$449.50"
]
}
]'Response
200 OK
[
{
"id": 1048201,
"number": "+18005551234",
"varValues": [
"John Carter",
"$199.00"
],
"addedAtLocal": "2026-10-02T11:24:05.310",
"attempts": 0,
"status": "NotContacted"
},
{
"id": 1048202,
"number": "+18005551235",
"varValues": [
"Jane Miller",
"$449.50"
],
"addedAtLocal": "2026-10-02T11:24:05.310",
"attempts": 0,
"status": "NotContacted"
}
]
