This endpoint will be used by providers to send SMS to customer maybe to notify them of their loan status or other specified purposes.
Request Message description
Field
# |
Field name | Data type | Max length | Required | Description |
1. | providerCode | String | 50 | true | The Code of the Channel from which this request originates. |
2. | msisdn | String | 20 | true | The Mobile Number of the Customer to whom the SMS will be sent |
3. | message | String | 160 | true | The SMS Content to be sent. |
4. | loanId | String | 50 | True | The loan Id of the customer receiving the message. |
Endpoint
POST /sms/send |
Headers
Response Message field description
Field
# |
Field name | Data type | Max length | Required | Description |
1 | responseCode | Numeric String | 5 | true | The code indicating the result of the processing of this request. |
2 | responseMessage | String | 255 | true | The Description of the responseCode. |
Sample Response (success)
{
“responseCode”: “00”, “responseMessage”: “Successful” } |
Sample Response (failure)
{
“responseCode” : “5000”, “responseMessage” : “Error while processing request. Please try again.” } |