SMSCancel

Endpoint: /api/v1/Sms/Cancel

This endpoint is part of the SMSDaemon API that allows external integration for sending SMS via the Herma platform./api/v1/Sms/Cancel

This operation allows to submit an SMS message with the following data:

RequestId: Gets or sets the request id which can be used to match requests with their corresponding responses.
- Value: The request id.

InmediateCancel: If cancellation is innmediate value shoud be true

If the SMS is received by the telecommunications service provider, you cannot cancell the submision.

Example of request in JSON

POST https://smsgateway.ecertia.com/api/v1/Sms/Submit HTTP/1.1
Accept: application/json
Content-type: application/json; charset=utf-8
Content-length: XXX
Authorization: Bearer xfgdsgfgfwedsfgsdsfgdsfgs4dfsfsDSADF==

{
    "RequestId": "e93845fa-8afd-4d35-8b5f-693441f69bff",
    "InmediateCancel": true
}

Example of response

HTTP/1.1 200 OK
Content-Type : application/json; charset=utf-8
Content-Length: xxx
 
{
    "RequestId": "e93845fa-8afd-4d35-8b5f-693441f69bff"
}

ERRORS Responses

Invalid Id

When a client tries to submit a new SMS with an invalid Id.

HTTP/1.1 400 Bad Request
Content-Type : application/json; charset=utf-8
Content-Length: xxx

{
    "type": "https://evicertia.com/sms/error/badrequest",
    "title": "Invalid parameters",
    "instance": "u4Jb76O99Ui5/XqWucyyFg",
    "code": 400,
    "detail": "The request failed because some parameters are not valid",
    "invalidValues": [
        {
            "path": "RequestId",
            "name": "RequestId",
            "error": "The field RequestId requires a non-default value"
        }
    ]
}