Contacts

Server

OmaxTelecom SMS Contacts API helps you manage contacts that are identified by a unique random ID. Using this ID, you can create, view, update, or delete contacts. This API works as a collection of customer-specific contacts that allows you to group them and assign custom values that you can later use when sending SMS template messages.

Create a contact

POST

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/store

Creates a new contact object. Returns the created contact object with each request.

Create a contact › path Parameters

group_id

string · required

Contact Groups uid

Create a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

PHONE

string · required

The phone number of the contact

Example: 8801721970168

FIRST_NAME

string

First name of the contact (optional, depends on contact group fields configuration)

Example: Jhon

LAST_NAME

string

Last name of the contact (optional, depends on contact group fields configuration)

Example: Doe

Create a contact › Responses

Successful response

status

string

data

object

Contact data with all details

Example: {"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T00:00:00Z"}

POST/contacts/{group_id}/store

curl https://api.omax.dev/sms/api/v1/contacts/:group_id/store \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "api_token": "534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68",
  "PHONE": "8801721970168",
  "FIRST_NAME": "Jhon",
  "LAST_NAME": "Doe"
}'

Example Request Body

{
  "api_token": "534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68",
  "PHONE": "8801721970168",
  "FIRST_NAME": "Jhon",
  "LAST_NAME": "Doe"
}

json

application/json

Example Responses

{
  "status": "success",
  "data": {
    "uid": "606732aec8705",
    "group_id": "6065ecdc9184a",
    "PHONE": "8801721970168",
    "FIRST_NAME": "Jhon",
    "LAST_NAME": "Doe",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

json

application/json

View a contact

POST

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/search/{uid}

Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.

View a contact › path Parameters

group_id

string · required

Contact Groups uid

uid

string · required

Contact uid

View a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

View a contact › Responses

Successful response

status

string

data

object

Contact data with all details

Example: {"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T00:00:00Z"}

Update a contact

PATCH

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/update/{uid}

Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.

Update a contact › path Parameters

group_id

string · required

Contact Groups uid

uid

string · required

Contact uid

Update a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

PHONE

string · required

The phone number of the contact

Example: 8801721970168

FIRST_NAME

string

First name of the contact (optional, depends on contact group fields configuration)

Example: Jhon

LAST_NAME

string

Last name of the contact (optional, depends on contact group fields configuration)

Example: Doe

Update a contact › Responses

Successful response

status

string

data

object

Updated contact data with all details

Example: {"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T12:00:00Z"}

PATCH/contacts/{group_id}/update/{uid}

curl https://api.omax.dev/sms/api/v1/contacts/:group_id/update/:uid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "api_token": "534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68",
  "PHONE": "8801721970168",
  "FIRST_NAME": "Jhon",
  "LAST_NAME": "Doe"
}'

Example Request Body

{
  "api_token": "534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68",
  "PHONE": "8801721970168",
  "FIRST_NAME": "Jhon",
  "LAST_NAME": "Doe"
}

json

application/json

Example Responses

{
  "status": "success",
  "data": {
    "uid": "606732aec8705",
    "group_id": "6065ecdc9184a",
    "PHONE": "8801721970168",
    "FIRST_NAME": "Jhon",
    "LAST_NAME": "Doe",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T12:00:00Z"
  }
}

json

application/json

Delete a contact

DELETE

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/delete/{uid}

Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.

Delete a contact › path Parameters

group_id

string · required

Contact Groups uid

uid

string · required

Contact uid

Delete a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

Delete a contact › Responses

Successful response

status

string

data

object

Deleted contact data

Example: {"uid":"606732aec8705","deleted":true}

View all contacts in group

POST

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/all

Retrieves all contacts in a specific contact group with pagination support.

View all contacts in group › path Parameters

group_id

string · required

Contact Groups uid

View all contacts in group › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

View all contacts in group › Responses

Successful response

status

string

object

Contacts data with pagination

Example: {"contacts":[{"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T00:00:00Z"}],"pagination":{"current_page":1,"total_pages":1,"total_items":1}}

POST/contacts/{group_id}/all

curl https://api.omax.dev/sms/api/v1/contacts/:group_id/all \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "api_token": "534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68"
}'

Example Request Body

{
  "api_token": "534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68"
}

json

application/json

Example Responses

{
  "status": "success",
  "data": {
    "contacts": [
      {
        "uid": "606732aec8705",
        "group_id": "6065ecdc9184a",
        "PHONE": "8801721970168",
        "FIRST_NAME": "Jhon",
        "LAST_NAME": "Doe",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "total_items": 1
    }
  }
}

json

application/json

Create a contact

POST

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/store

Creates a new contact object. Returns the created contact object with each request.

Create a contact › path Parameters

group_id

string · required

Contact Groups uid

Create a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

PHONE

string · required

The phone number of the contact

Example: 8801721970168

FIRST_NAME

string

First name of the contact (optional, depends on contact group fields configuration)

Example: Jhon

LAST_NAME

string

Last name of the contact (optional, depends on contact group fields configuration)

Example: Doe

Create a contact › Responses

Successful response

status

string

data

object

Contact data with all details

Example: {"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T00:00:00Z"}

View a contact

POST

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/search/{uid}

Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.

View a contact › path Parameters

group_id

string · required

Contact Groups uid

uid

string · required

Contact uid

View a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

View a contact › Responses

Successful response

status

string

data

object

Contact data with all details

Example: {"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T00:00:00Z"}

Update a contact

PATCH

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/update/{uid}

Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.

Update a contact › path Parameters

group_id

string · required

Contact Groups uid

uid

string · required

Contact uid

Update a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

PHONE

string · required

The phone number of the contact

Example: 8801721970168

FIRST_NAME

string

First name of the contact (optional, depends on contact group fields configuration)

Example: Jhon

LAST_NAME

string

Last name of the contact (optional, depends on contact group fields configuration)

Example: Doe

Update a contact › Responses

Successful response

status

string

data

object

Updated contact data with all details

Example: {"uid":"606732aec8705","group_id":"6065ecdc9184a","PHONE":"8801721970168","FIRST_NAME":"Jhon","LAST_NAME":"Doe","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-01-01T12:00:00Z"}

Delete a contact

DELETE

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/delete/{uid}

Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.

Delete a contact › path Parameters

group_id

string · required

Contact Groups uid

uid

string · required

Contact uid

Delete a contact › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

Delete a contact › Responses

Successful response

status

string

data

object

Deleted contact data

Example: {"uid":"606732aec8705","deleted":true}

View all contacts in group

POST

https://api.omax.dev/sms/api/v1

/contacts/{group_id}/all

Retrieves all contacts in a specific contact group with pagination support.

View all contacts in group › path Parameters

group_id

string · required

Contact Groups uid

View all contacts in group › Request Body

api_token

string · required

API Token from Developers option

Example: 534|pBusBf2Uay3LYM2NDKYfB9jzVNCojnG4E46ujYaN7bbdac68

View all contacts in group › Responses

Successful response

status

string

object

Contacts data with pagination