Opt In / Opt Out

Manage RCS opt-in and opt-out lists for recipients, per sender and message type.

Manage which recipients are opted in or opted out of receiving RCS messages, scoped by sender and message type (promotional or transactional). Use these endpoints to check, add, and remove numbers from each list.

All requests are authenticated with the apikey header. See RCS Messaging Overview.

Opt Out list

Get opt-out list

apikey · string · required

Your OneXtel API key.

GET https://api.onexaura.com/opt/out/rcs

cURL

curl --location 'https://api.onexaura.com/opt/out/rcs' \
--header 'apikey: YOUR_API_KEY'

Response

{
  "status": "success",
  "description": "success",
  "data": [
    {
      "tucid": "YOUR_TUC_ID",
      "sender": "your_rcs_sender",
      "number": "919999999999",
      "name": "Customer name",
      "message_type": "promotional",
      "channel": "rcs",
      "category_id": "1234"
    }
  ]
}

status · string

success when the request was served. Present on both lists, empty or not.

data · array

One entry per number on the list. An empty list returns "data": [].

data[].number · string

The recipient’s number, with country code.

data[].sender · string

The RCS sender the entry applies to. The list covers the whole account, so entries for several senders can come back together.

data[].message_type · string

promotional or transactional — an entry is scoped to one type.

data[].tucid · string

The account the entry belongs to.

Add to opt-out list

apikey · string · required

Your OneXtel API key.

POST https://api.onexaura.com/opt/out/rcs

numbers · array · required

Array of recipient phone numbers to opt out.

sender · string · required

RCS sender/bot ID the opt-out applies to.

message_types · array · required

Message types to opt the numbers out of, e.g. ["promotional", "transactional"].

Request

{
  "numbers": ["919999999999", "919888888888"],
  "sender": "your_rcs_sender",
  "message_types": ["promotional", "transactional"]
}

cURL

curl --location 'https://api.onexaura.com/opt/out/rcs' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "numbers": ["919999999999", "919888888888"],
  "sender": "your_rcs_sender",
  "message_types": ["promotional", "transactional"]
}'

Remove from opt-out list

apikey · string · required

Your OneXtel API key.

DELETE https://api.onexaura.com/opt/out/rcs

number · string · required

Recipient phone number to remove from the opt-out list.

sender · string · required

RCS sender/bot ID the opt-out applies to.

message_type · string · required

Message type to remove the opt-out for. One of promotional, transactional.

cURL

curl --location --request DELETE 'https://api.onexaura.com/opt/out/rcs?number=919999999999&sender=your_rcs_sender&message_type=promotional' \
--header 'apikey: YOUR_API_KEY'

Opt In list

Get opt-in list

apikey · string · required

Your OneXtel API key.

GET https://api.onexaura.com/opt/in/rcs

cURL

curl --location 'https://api.onexaura.com/opt/in/rcs' \
--header 'apikey: YOUR_API_KEY'

Response

{
  "status": "success",
  "description": "success",
  "data": [
    {
      "tucid": "YOUR_TUC_ID",
      "sender": "your_rcs_sender",
      "number": "919999999999",
      "name": "Customer name",
      "message_type": "promotional",
      "channel": "rcs",
      "category_id": "1234"
    }
  ]
}

status · string

success when the request was served. Present on both lists, empty or not.

data · array

One entry per number on the list. An empty list returns "data": [].

data[].number · string

The recipient’s number, with country code.

data[].sender · string

The RCS sender the entry applies to. The list covers the whole account, so entries for several senders can come back together.

data[].message_type · string

promotional or transactional — an entry is scoped to one type.

data[].tucid · string

The account the entry belongs to.

Add to opt-in list

apikey · string · required

Your OneXtel API key.

POST https://api.onexaura.com/opt/in/rcs

numbers · array · required

Array of recipient phone numbers to opt in.

sender · string · required

RCS sender/bot ID the opt-in applies to.

message_types · array · required

Message types to opt the numbers into, e.g. ["promotional", "transactional"].

Request

{
  "numbers": ["919999999999", "919888888888"],
  "sender": "your_rcs_sender",
  "message_types": ["promotional", "transactional"]
}

cURL

curl --location 'https://api.onexaura.com/opt/in/rcs' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "numbers": ["919999999999", "919888888888"],
  "sender": "your_rcs_sender",
  "message_types": ["promotional", "transactional"]
}'

Remove from opt-in list

apikey · string · required

Your OneXtel API key.

DELETE https://api.onexaura.com/opt/in/rcs

number · string · required

Recipient phone number to remove from the opt-in list.

sender · string · required

RCS sender/bot ID the opt-in applies to.

message_type · string · required

Message type to remove the opt-in for. One of promotional, transactional.

cURL

curl --location --request DELETE 'https://api.onexaura.com/opt/in/rcs?number=919999999999&sender=your_rcs_sender&message_type=promotional' \
--header 'apikey: YOUR_API_KEY'