Skip to main content

​
Fetch Sender ID

Endpoint: https://BASE_URL/api/sender-id?api_key=api-key Request Type: Get Sample Response: 
  {
      "current_page": 1,
      "data": [
          {
              "sender_id": "ACME Key",
              "status": "unblock",
              "company": ACME,
              "usecase": null,
              "country": null,
              "created_at": "2021-03-29 16:51:53"
          },
          {
              "sender_id": "ACME Alert",
              "status": "unblock",
              "company": ACME,
              "usecase": null,
              "country": null,
              "created_at": "2021-03-29 16:51:09"
          },
          {
              "sender_id": "ACME Wall",
              "status": "unblock",
              "company": ACME,
              "usecase": null,
              "country": null,
              "created_at": "2021-03-29 16:50:38"
          },
          {
              "sender_id": "Hooli",
              "status": "unblock",
              "company": Hooli,
              "usecase": null,
              "country": null,
              "created_at": "2021-03-26 13:19:16"
          },
          {
              "sender_id": "Google",
              "status": "unblock",
              "company": null,
              "usecase": null,
              "country": null,
              "created_at": "2021-01-19 17:41:30"
          },
          {
              "sender_id": "Facebook",
              "status": "unblock",
              "company": null,
              "usecase": null,
              "country": null,
              "created_at": "2021-01-19 17:41:14"
          },

      ],
      "first_page_url": "https://BASE_URL/api/sender-id?page=1",
      "from": 1,
      "last_page": 47,
      "last_page_url": "https://BASE_URL/api/sender-id?page=47",
      "next_page_url": "https://BASE_URL/api/sender-id?page=2",
      "path": "https://BASE_URL/api/sender-id",
      "per_page": 10,
      "prev_page_url": null,
      "to": 15,
      "total": 704
  }

​
Request Sender ID

Endpoint: https://BASE_URL/api/sender-id/request Request Type: Post Sample Response:
OptionsRequiredDescription
api*keyyes_string*
Your API key (It can be found on your Termii dashboard).
sender*idyes_string*
Represents the ID of the sender which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example:CompanyName)
usecaseyesstring
A sample of the type of message sent.
companyyesstring
Represents the name of the company with the sender ID.
{
  "api_key":"Your API key",
  "sender_id": "Acme",
  "usecase": "Your OTP code is zxsds",
  "company": "Acme Corp"
}
Response: 
{
    "code": "ok",
    "message": "Sender Id requested. You will be  contacted by your account manager."
}