MTC Get Number Assignment
MTC Number Assignment API allows Providers and Direct Merchants to retrieve a list of MTC number for their Provider/Merchant combo. A WebServiceInvocation record is inserted for every use. Authorized users of the API will have an entry in the APIKey table.
Location:
WebAPI/Controllers/MTC/GetMTCNumberAssignment/
URL:
- api.contactatonce.com/api/v1.0/getmtcnumberassignment/
- api.contactatonce.co.uk/api/v1.0/getmtcnumberassignment/
- api.contactatonce.com.au/api/v1.0/getmtcnumberassignment/
Parameters
Authorization header: “basic” + space + ApiKey
Request
Parameter Type Required Description
ReferenceId String Required for Provider The ReferenceId assigned to the Provider's merchant.
IncludeInactive bool(0,1) Required The MTC numbers that have been released.
Response
Response | ||
---|---|---|
Parameter | Type | Description |
AdvertiserId | String | The Advertiser's unique identifier. |
AdvertiserName | String | The name if the Advertiser. |
AssignedNumbers | String | List with the following: |
Status | String | Will contain one of the following messages: 0 = Success 1 = Failure |
Application Messages
- EventCode:
“MTCGetNumberAssignmentError” = 6403 - Error Messages:
“The ReferenceId provided does not exist for specified provider”
“An error occurred processing your request”
Application Tasks
Validation
- For provider, ensure referenceId matches a qualified merchant.
Action
- If user is DM, get MerchantId from directMerchantProvider table, otherwise use merchantid obtained from ReferenceId
- ProviderId set from APIKey
- Retrieve TextToChatNumbers based on IncludeInactive input
- Return Populated Response
Sample Request
Header
Authorization basic 64AC79BA-B2CE-42CF-97EE-99A0A6DD2F2x
Body
{ "ReferenceId" : "66147a", "IncludeInactive" : 1, }