Provision

post

https://api.callcap.com/v3/numbers/

Using this API, the number will be immediately ready for use and will incur any charges as normal.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For advanced users, you may also pass in any of the arguments used in the number search GET resource. This will find the first phone number that matches your search criteria and provision it for you.

Query Params

locationID

integer

required

A Callcap location account is required for the phone number to be provisioned.

phoneNumber

string

required

If you've previously found a phone number to provision, specify the exact number here. If you haven't found an available number, please use the 'Phone Numbers - Search' API.

destination

string

required

The phone number that the Callcap number should ring to.

campaignName

string

required

The name for the created "campaign" for the provisioned phone number. If not set, the campaign name will default to the phone number chosen.

notes

string

Any longform notes to store with the phone number campaign.

memo1

string

A way to store extra information, for example to store account associations in your own system.

memo2

string

A way to store extra information, for example to store account associations in your own system.

recording

boolean

Defaults to false (off)

Whether phone call recording should be on or off.

evaluation

string

Defaults to off

Whether calls should be evaluated in realtime using Callsurance.
Available options available:
- off
- realtime

mediaTypeID

integer

Media type ID corresponding to a medium. Note: Please contact Customer Success to get a list of IDs.

brand

string

Brand associated with the campaign

service

string

Ad service line

target

string

Ad target

offer

string

Ad offer/coupon

Response

200