SMS endpoints
AllocateSMSCredits
AllocateSMSCredits(System.Int32,DataLayer.Entity.Transaction.BillingStyle,System.String)
Allocate SMS credits to a child account. SMS credits are not only required for SMS tokens, but for all SMS notification generated by the system. If your account has it's own SMS configuration, allocation of SMS credits does not require SMS credits.
Parameters
Param: quantity: Number of credits to allocate
Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer
Param: toOrganization: Account to allocate to
Returns:
- True if allocated successfully
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
DeallocateSMSCredits
DeallocateSMSCredits(System.Int32,System.String)
De-allocate SMS credits from a child account.
Parameters
Param: quantity: Number of credits to de-allocate
Param: fromOrganization: Account to take the credits from
Returns:
- True if the credits have been de-allocated
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
RequestSMS
RequestSMS(System.String,System.String,System.String)
Used to request that a new SMS message be sent to a user. This requires their PIN for validation.
Parameters
Param: userName: User the SMS is for
Param: PIN: PIN of the SMS token
Param: organization: Account
Returns
True if an SMS message has been sent
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response: