Add Sender

POST

https://rest.qikberry.ai/v1/sms/senders

This endpoint enables to add a new sender ID in account.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.qikberry.ai/v1/sms/senders' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": [
    {
      "sender": "QIKBRY",
      "service": "T",
      "entity_id": "100164421522312XXXX",
      "entity_name": "Company Legal Name",
      "iso_code": "IN"
    }
  ]
}'

Response Example

200 - Success

{
    "message": "Senders added successfully",
    "data": [
        {
            "sender": "QIKBRY",
            "service": "T",
            "entityId": "100164421522312XXXX",
            "entityName": "Company Legal Name",
            "iso_code": "IN"
        }
    ],
    "error": {}
}

Request

Header Params

Authorization

string

required

Pass access token

Example:

Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Content-Type

string

required

Example:

application/json

Body Params application/json

data

array [object {5}]

required

sender

string

required

Length must be 4 or 6, Only alphabets and numbers are allowed.

>= 4 characters<= 6 characters

Examples:

QBERRYQKSHOP

Match pattern:

/^[a-zA-Z0-9]*$/

service

string

required

Pass service code. Allowed values: T, P

Examples:

entity_id

string

required

Length must be between 10 and 25 & Only numbers are allowed.

>= 10 characters<= 25 characters

Example:

100164421522312XXXX

Match pattern:

/^[0-9]*$/

entity_name

string

required

Length must be between 5 and 50 & Only alphabets and numbers are allowed.

>= 5 characters<= 50 characters

Example:

Company Legal Name

Match pattern:

/^[0-9a-zA-Z.&_ ]*$/

iso_code

string

optional

Country ISO Code

Default:

Example:

For India pass IN

Examples

Responses

🟢200Success

application/json

Body

message

string

required

Response message

data

array [object {5}]

required

service

string

required

sender

string

required

Example:

QIKBRY

entity_id

string

required

entity_name

string

required

Example:

Company Legal Name

iso_code

string

optional

error

object

required

if any error

🟠400Validation Error

Get Sender

Update Sender