Automations

/

SMS

Everything about Inbound SMS Rules

Servers

https://rest.clicksend.com/

View SMS Inbound Automations

Request

Get all inbound sms automations

Get all inbound sms automations

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/sms/inbound'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your list of inbound rules."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your list of inbound rules.",
  "data": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [ … ]
  }
}

Create SMS Inbound Automation

Request

Create new inbound sms automation

Create new inbound sms automation

Name	Type	Required	Restrictions	Description
dedicated_number	string	true	none	Decicated Number. Can be '*' to apply to all numbers.
rule_name	string	true	none	Rule Name.
message_search_type	number	true	none	Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.
message_search_term	string	true	none	Message search term.
action	string	true	none	Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
action_address	string	true	none	Action address.
enabled	number	true	none	Enabled: Disabled=0 or Enabled=1.
webhook_type	string	false	URL action only	Set as post, get, or json to change the format of the request sent.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

dedicated_numberstring

Example: "*"

rule_namestring

Example: "IFTTT Test"

message_search_typeinteger

message_search_termstring or null

actionstring

Example: "POLL"

action_addressstring

bodystring or null

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"dedicated_number\":\"+61298441484\",
    \"rule_name\":\"My Rule\",
    \"message_search_type\":3,
    \"message_search_term\":\"My Search Term\",
    \"action\":\"EMAIL_FIXED\",
    \"action_address\":\"john@doe.com\",
    \"enabled\":1,
    \"webhook_type\":\"json\"
}" \
'https://rest.clicksend.com/v3/automations/sms/inbound'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your record has been added."

dataobject(sms_inbound_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your record has been added.",
  "data": {
    "inbound_rule_id": 10,
    "dedicated_number": "+61298441484",
    "rule_name": "My Rule 10",
    "message_search_type": 3,
    "message_search_term": "My Search Term",
    "action": "CREATE_CONTACT_PLUS_EMAIL",
    "action_address": "430",
    "body": "Hello, World!",
    "enabled": 1
  }
}

View SMS Inbound Automation

Request

Get specific inbound sms automation

Get specific inbound sms automation

Parameters

Parameter	In	Type	Required	Description
inbound_rule_id	path	integer(int32)	true	Inbound rule id

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

inbound_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/sms/inbound/{inbound_rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your inbound rule."

dataobject(sms_inbound_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your inbound rule.",
  "data": {
    "inbound_rule_id": 10,
    "dedicated_number": "+61298441484",
    "rule_name": "My Rule 10",
    "message_search_type": 3,
    "message_search_term": "My Search Term",
    "action": "CREATE_CONTACT_PLUS_EMAIL",
    "action_address": "430",
    "body": "Hello, World!",
    "enabled": 1
  }
}

Update SMS Inbound Automation

Request

Update inbound sms automation

Update inbound sms automation

Parameters

Parameter	In	Type	Required	Description
inbound_rule_id	path	integer(int32)	true	Inbound rule id

Properties

Name	Type	Required	Restrictions	Description
dedicated_number	string	true	none	Dedicated Number. Can be '*' to apply to all numbers.
rule_name	string	true	none	Rule Name.
message_search_type	number	true	none	Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.
message_search_term	string	true	none	Message search term.
action	string	true	none	Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
action_address	string	true	none	Action address.
enabled	number	true	none	Enabled: Disabled=0 or Enabled=1.
webhook_type	string	false	URL action only	Set as post, get, or json to change the format of the request sent.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

inbound_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

dedicated_numberstring

Example: "+61411111111"

rule_namestring

Example: "My Rule"

message_search_typeinteger

message_search_termstring

Example: "My Search Term"

actionstring

Example: "SMS"

action_addressstring

Example: "15627562233"

enabledinteger

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"dedicated_number\":\"+61298441484\",
    \"rule_name\":\"My Rule\",
    \"message_search_type\":3,
    \"message_search_term\":\"My Search Term\",
    \"action\":\"EMAIL_FIXED\",
    \"action_address\":\"john@doe.com\",
    \"enabled\":1,
    \"webhook_type\":\"json\"
}" \
'https://rest.clicksend.com/v3/automations/sms/inbound/{inbound_rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your record has been updated."

dataobject(sms_inbound_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your record has been updated.",
  "data": {
    "inbound_rule_id": 10,
    "dedicated_number": "+61298441484",
    "rule_name": "My Rule 10",
    "message_search_type": 3,
    "message_search_term": "My Search Term",
    "action": "CREATE_CONTACT_PLUS_EMAIL",
    "action_address": "430",
    "body": "Hello, World!",
    "enabled": 1
  }
}

Delete SMS Inbound Automation

Request

Delete inbound sms automation

Delete inbound sms automation

Parameters

Parameter	In	Type	Required	Description
inbound_rule_id	path	integer(int32)	true	Inbound rule id

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

inbound_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/automations/sms/inbound/{inbound_rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your record has been deleted."

dataArray of items

Example: []

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your record has been deleted.",
  "data": []
}

View SMS Delivery Receipt Rules

Request

Get all sms delivery receipt automations

Get all sms delivery receipt automations

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/sms/receipts'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your list of rule incoming sms receipt."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your list of rule incoming sms receipt.",
  "data": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [ … ]
  }
}

Create SMS Delivery Receipt Rule

Request

Create sms delivery receipt automations

Create sms delivery receipt automations

Properties

Name	Type	Required	Restrictions	Description
rule_name	string	true	none	Rule Name.
match_type	number	true	none	Match Type. 0=All reports.
action	string	true	none	Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
action_address	string	true	none	Action address.
enabled	number	true	none	Enabled: Disabled=0 or Enabled=1.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

rule_namestring

Example: "My Rule"

match_typeinteger

Example: 1

actionstring

Example: "EMAIL_FIXED"

action_addressstring

Example: "john@doe.com"

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"rule_name\": \"My Rule\",
    \"match_type\": 3,
    \"action\": \"EMAIL_FIXED\",
    \"action_address\": \"john@doe.com\",
    \"enabled\": 1
}" \
'https://rest.clicksend.com/v3/automations/sms/receipts'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your new SMS receipt has been added."

dataobject(sms_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your new SMS receipt has been added.",
  "data": {
    "receipt_rule_id": 5,
    "rule_name": "My Rule",
    "match_type": 0,
    "action": "EMAIL_FIXED",
    "action_address": "john@doe.com",
    "enabled": 1
  }
}

View SMS Delivery Receipt Rule

Request

Get specific sms delivery receipt automation

Get specific sms delivery receipt automation

Parameters

Parameter	In	Type	Required	Description
receipt_rule_id	path	integer(int32)	true	Receipt rule id

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

receipt_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/sms/receipts/{receipt_rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your rule incoming voice receipt."

dataobject(sms_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming voice receipt.",
  "data": {
    "receipt_rule_id": 5,
    "rule_name": "My Rule",
    "match_type": 0,
    "action": "EMAIL_FIXED",
    "action_address": "john@doe.com",
    "enabled": 1
  }
}

Update SMS Delivery Receipt Rule

Request

Update sms delivery receipt automation

Update sms delivery receipt automation

Parameters

Parameter	In	Type	Required	Description
receipt_rule_id	path	integer(int32)	true	Receipt rule id

Properties

Name	Type	Required	Restrictions	Description
rule_name	string	true	none	Rule Name.
match_type	number	true	none	Match Type. 0=All reports.
action	string	true	none	Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
action_address	string	true	none	Action address.
enabled	number	true	none	Enabled: Disabled=0 or Enabled=1.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

receipt_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

rule_namestring

Example: "My Rule"

match_typeinteger

Example: 1

actionstring

Example: "EMAIL_FIXED"

action_addressstring

Example: "john@doe.com"

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"rule_name\": \"My Rule\",
    \"match_type\": 3,
    \"action\": \"EMAIL_FIXED\",
    \"action_address\": \"john@doe.com\",
    \"enabled\": 1
}" \
'https://rest.clicksend.com/v3/automations/sms/receipts/{receipt_rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your rule incoming sms receipt has been updated."

dataobject(sms_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming sms receipt has been updated.",
  "data": {
    "receipt_rule_id": 5,
    "rule_name": "My Rule",
    "match_type": 0,
    "action": "EMAIL_FIXED",
    "action_address": "john@doe.com",
    "enabled": 1
  }
}

Delete SMS Delivery Receipt Rule

Request

Delete sms delivery receipt automation

Delete sms delivery receipt automation

Parameters

Parameter	In	Type	Required	Description
receipt_rule_id	path	integer(int32)	true	Receipt rule id

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

receipt_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/automations/sms/receipts/{receipt_rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your rule incoming sms receipt has been deleted."

dataArray of items

Example: []

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming sms receipt has been deleted.",
  "data": []
}