GetOTP Documentation

Sender

The Sender API provides a way to get a specific Sender ID.

Request for Sender API

To get a specific Sender, make a GET request to our Senders endpoint with the Sender ID.

https://api.otp.dev/v1/senders/{sender_id}

With the following Basic HTTP verification method:

Description	Required	Data Type	Example
Your API Key	Yes	String	mtbi2w4hlendfpxa1igthcu5p6mzxf7k

Note

Grab your API key from this page

With the following parameters:

Name	Description	Required	Data Type	Example
sender_id	The unique identifier of the sender	Yes	String	3fa85f64-5717-4562-b3fc-2c963f66afa6

Examples

Below is an example request using cURL:

curl --request GET \
     --url 'https://api.otp.dev/v1/senders/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
     --header 'X-OTP-Key: {YOUR_API_KEY}' \
     --header 'accept: application/json'

The response would be a JSON structure, returned with HTTP 200 Codestatus code:

{
    "data": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "My Sender",
        "code": "My Sender",
        "channel": "SMS",
        "type": "Alphanumeric",
        "status": "Available",
        "country": "de",
        "countries": [
            "de"
        ],
        "monthly_cost": "2",
        "setup_cost": "2",
        "create_date": "2025-09-24 07:44:25",
        "update_date": "2025-09-24 07:44:25",
        "links": { 
            "self": "string",
            "account": "string"
        }
    }
}

Response data details:

Name	Description	Data Type	Example
data.id	The unique identifier of the sender	String (UUID)	3fa85f64-5717-4562-b3fc-2c963f66afa6
data.account_id	The unique identifier of the account	String (UUID)	3fa85f64-5717-4562-b3fc-2c963f66afa6
data.name	Human-friendly sender name	String	My Sender
data.code	Sender ID/code used for messaging	String	MySender
data.channel	Messaging channel	String	SMS
data.type	Sender type	String	Alphanumeric
data.status	Approval/availability status	String	Available
data.country	Primary country (ISO 3166-1 alpha-2)	String	de
data.countries	Supported countries (ISO 3166-1 alpha-2)	Array<String>	["de"]
data.monthly_cost	Monthly cost for the sender	String	2
data.setup_cost	One-time setup cost for the sender	String	2
data.create_date	Creation date of the sender in UTC, formatted as yyyy-mm-dd hh:mm:ss	String (datetime)	2025-09-24 07:09:20
data.update_date	Updated date of the sender in UTC, formatted as yyyy-mm-dd hh:mm:ss	String (datetime)	2025-09-24 07:09:20
data.links.self	URL of the sender	String (URL)	string
data.links.account	URL of the account	String (URL)	string

If there is an error with the API call, you will receive a JSON response with 400+ status code, error code and message.

{
    "errors": [{
        "timestamp": "2025-08-18 00:00:00",
        "path": "/v1/senders/3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "method": "GET",
        "status": 404,
        "message": "Sender not found",
        "code": "1402"
    }]
}

Please refer to this table for details:

Error Code	Description	HTTP Code
1402	Sender not found	404