Get forwarding rules by campaign

GET

https://api.youratlas.com/v1/api/call-forward/:campaignId

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

campaignIdstringRequired

Successful response

PhoneNumberstring

Whostring

Typeenum

Allowed values:

Extensionstring

TransferMessagestring

TransferWithSummaryboolean

SIPURIstring

SIPHeadersstring

JSON-serialized SIP headers

PartitionKeystring

RowKeystring

Timestampdatetime

500

Internal Server Error

1	[
2	{
3	"PhoneNumber": "+14155552671",
4	"Who": "Support Team",
5	"Type": "number",
6	"Extension": "102",
7	"TransferMessage": "Please hold while we transfer your call.",
8	"TransferWithSummary": true,
9	"SIPURI": "sip:support@voip.youratlas.com",
10	"SIPHeaders": "{\"X-Custom-Header\":\"Value123\"}",
11	"PartitionKey": "campaign-98765",
12	"RowKey": "forward-12345",
13	"Timestamp": "2024-01-15T09:30:00Z"
14	}
15	]

1	curl https://api.youratlas.com/v1/api/call-forward/campaignId \
2	-H "api-key: <apiKey>" \
3	-H "Content-Type: application/json"