Partner Manager REST Service
Description
The Partner Manager REST Service allows authorized third parties to manage external Mobile Text Connect numbers.
Requests
Base URL (regionally defined):
- North America : https://api.contactatonce.com/
- Australia : https://api.contactatonce.com.au/
- Europe : https://api.contactatonce.co.uk/
Assign External Mobile Text Connect Number
Format : JSON
Method : POST
URI : /api/v1.0/ExternalMobileTextConnectNumber/Assign/
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
Credentials | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
ProviderId | Int | Required | ProviderId assigned by ContactAtOnce! to each Provider. |
AdvertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
NumberRequest | ExternalMTCNumberRequest | Required | Partner's identifier for the mutual customer. |
Response | ||
---|---|---|
Paremeter | Type | Description |
Success | Boolean | Indicates whether call was success or not. |
Description | String | Nullable. Descriptive text that describes user exceptions. |
Sample JSON POST
{
"Credentials": {
"Id": 8276,
"UserName": "user@here.com",
"Password": "pw_here"
},
"ProviderId": 123,
"AdvertiserId": "1659",
"NumberRequest": {
"Number": "14045551212",
"CallForwardNumber": "18888888888",
"IsPrimary": true,
"MMSEnabled": true,
"EnableTrackedCallAlerts": false,
"EnableTextFollowUp": false,
"EnableTakeItOnTheGo": true,
"EnableLeads": true
},
}
Sample JSON Response
{
"Success": true,
"Description": null
}
UnAssign External Mobile Text Connect Number
Format : JSON
Method : POST
URI : /api/v1.0/ExternalMobileTextConnectNumber/UnAssign/
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
Credentials | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
ProviderId | Int | Required | ProviderId assigned by ContactAtOnce! to each Provider. |
AdvertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
Number | String | Required | MTC number to be unassigned. |
Response | ||
---|---|---|
Paremeter | Type | Description |
Success | Boolean | Indicates whether call was success or not. |
Description | String | Nullable. Descriptive text that describes user exceptions. |
Sample JSON POST
{
"Credentials": {
"Id": 8276,
"UserName": "username@here.com",
"Password": "pw_here"
},
"ProviderId": 225,
"AdvertiserId": "1659",
"Number": "1777777777"
}
Sample JSON Response
{
"Success": true,
"Description": null
}
Retrieve External Mobile Text Connect Number
Format : JSON
Method : POST
URI : /api/v1.0/ExternalMobileTextConnectNumber/Retrieve/
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
Credentials | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
ProviderId | Int | Required | ProviderId assigned by ContactAtOnce! to each Provider. |
AdvertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
Response | ||
---|---|---|
Paremeter | Type | Description |
Success | Boolean | Indicates whether call was success or not. |
Description | String | Nullable. Descriptive text that describes user exceptions. |
Sample JSON POST
{
"Credentials": {
"Id": 8276,
"UserName": "user@here.com",
"Password": "pw_here"
},
"ProviderId": 225,
"AdvertiserId": "1659"
}
Sample JSON Response
{
"Payload": [
{
"AdvertiserId": "1659",
"Number": "16788274119",
"CallForwardNumber": "16783720312",
"IsPrimary": false,
"MMSEnabled": false,
"EnableTrackedCallAlerts": true,
"EnableTextFollowUp": true,
"EnableTakeItOnTheGo": true,
"EnabledLeads": true
},
{
"AdvertiserId": "1659",
"Number": "1777777777",
"CallForwardNumber": "8888888888",
"IsPrimary": true,
"MMSEnabled": false,
"EnableTrackedCallAlerts": true,
"EnableTextFollowUp": true,
"EnableTakeItOnTheGo": true,
"EnabledLeads": true
}
],
"Success": true,
"Description": null
}
If you require assistance, please click on the “We’re In” button below, call 1 (678) 648-6961 or email us at support@contactatonce.com.