Delete Sender ID

kaleyra.io enables you to delete a single Sender ID or multiple sender IDs in bulk using this API.

📘

Note:

The maximum number of sender IDs that could be deleted at an instance is 100.

Prerequisites

• Before sending the SMS, you must configure the SMS channel in kaleyra.io.
• After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
• Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.

Base URL

https://<api_domain>/v1/<SID>

API Domain and Value

API request to Delete Sender IDs

To delete sender IDs use the <api_domain>/v1/<sid>/sms/sender endpoint with the following request method:

Request Format

The following is the request format to delete sender IDs:

curl --location --request DELETE 'https://<api_domain>/v1/<sid>/sms/sender' \
--header 'api-key:<api-key>' \
--header 'Content-Type:<content-type>' \
--data '{
    "sender":[<sender_id1>, <sender_id2>]
}'

Sample Request Format

The following is the request format to delete sender IDs:

curl --location --request DELETE 'https://api.kaleyra.io/v1/HXXXXXXX071IN/sms/sender' \
--header 'api-key:Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
--header 'Content-Type:application/json' \
--data '{
    "sender":["ADPAI", "JSONSEND"]
}'

URL Parameters and Headers

Following is the list of parameters and headers to send the outgoing message request:

Following is the list of parameters and data types supported for deleting the sender ID:

Success Response

The following success response is received when the JSON script has the correct syntax:

{
    "code": "MSG108",
    "message": "Sender ID(s) deleted successfully",
    "data": [],
    "error": {}
}

Failure Responses

The following failure responses are received when the JSON script has an incorrect syntax:

{
    "code": "RBC195",
    "message": "Sender key is Mandatory in the body. And cannot be empty",
    "data": [],
    "error": {}
}

SMS Error Codes, SMS Status and Status Trace Codes

Refer to the following links for Error Codes, Status and Status Trace Codes:

• For information related to SMS error codes, see SMS Error Codes.
• For information related to SMS status and status trace codes, see SMS Status and Status Trace Codes.