POST v1/api/SendSmsMessage
Send Sms Message
Request Information
URI Parameters
None.
Body Parameters
SendSmsMessageRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId | string |
None. |
|
| CommunicationChannel | CommunicationChannelEnum |
None. |
|
| CommunicationSubChannel | string |
None. |
|
| Type | SMSMessageTypeEnum |
None. |
|
| CompanyCode | SBLICompanyEnum |
None. |
|
| PolicyId | string |
None. |
|
| ClientId | string |
None. |
|
| FromCountryCode | string |
None. |
|
| FromNumber | string |
None. |
|
| ToCountryCode | string |
None. |
|
| ToNumber | string |
None. |
|
| SendImmediately | boolean |
None. |
|
| BodyMessage | string |
None. |
|
| TemplateId | string |
None. |
|
| TemplateProperties | Collection of TemplatePropertyDto |
None. |
Request Formats
application/json
Sample:
REQUEST
{
"CommunicationChannel": "Service",
"CommunicationSubChannel": "BASE",
"CompanyCode": "S1",
"PolicyId": "257607938",
"ClientId": "2735312248",
"ToCountryCode": "1",
"ToNumber": "9789999999",
"FromNumber": "99999",
"TemplateId": "Prod-2400"
}
application/xml
Sample:
REQUEST
<SendSmsMessageRequestDto>
<CommunicationChannel>Service</CommunicationChannel>
<CommunicationSubChannel>BASE</CommunicationSubChannel>
<CompanyCode>S1</CompanyCode>
<PolicyId>257607938</PolicyId>
<ClientId>2735312248</ClientId>
<ToCountryCode>1</ToCountryCode>
<ToNumber>9782395798</ToNumber>
<FromNumber>8722040155</FromNumber>
<TemplateId>Prod-2400</TemplateId>
</SendSmsMessageRequestDto>
Response Information
Resource Description
stringResponse Formats
application/json
Sample:
RESPONSE
{
"FromNumber": "99999",
"MessageId": "ca20eb31-3ca5-4b8f-b6c6-7d145c205a0b",
"NotifyId": "fdbe5dea-b2b4-4ef4-920c-513a2e1b32ba",
"ToNumber": "9789999999",
}
application/xml
Sample:
RESPONSE
<SendSmsMessageResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<FromNumber>99999</FromNumber>
<MessageId>ca20eb31-3ca5-4b8f-b6c6-7d145c205a0b</MessageId>
<NotifyId>fdbe5dea-b2b4-4ef4-920c-513a2e1b32ba</NotifyId>
<ToNumber>9789999999</ToNumber>
</SendSmsMessageResponseDto>