SMS (1.0.0)

Everything about Inbound SMS Rules

View SMS Inbound Automations

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...

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/automations/sms/inbound

Request samples

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

Response samples

200

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": [{"sms_inbound_rule_id": 1,
"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": "test@test.com",
"enabled": 1
},
{"sms_inbound_rule_id": 9,
"dedicated_number": "+61298441484",
"rule_name": "My Rule 9",
"message_search_type": 3,
"message_search_term": "My Search Term",
"action": "CREATE_CONTACT",
"action_address": "john@doe.com",
"body": null,
"enabled": 1
}
]
}
}

Create SMS Inbound Automation

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...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/automations/sms/inbound

Request samples

application/json

{"dedicated_number": "*",
"rule_name": "IFTTT Test",
"message_search_type": 0,
"message_search_term": null,
"action": "POLL",
"action_address": "",
"body": null,
"enabled": 1
}

Response samples

200

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

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...

Request

path Parameters

inbound_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/automations/sms/inbound/{inbound_rule_id}

Request samples

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

Response samples

200

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

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...

Request

path Parameters

inbound_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

put/v3/automations/sms/inbound/{inbound_rule_id}

Request samples

application/json

{"dedicated_number": "+61411111111",
"rule_name": "My Rule",
"message_search_type": 0,
"message_search_term": "My Search Term",
"action": "SMS",
"action_address": "15627562233",
"enabled": 0
}

Response samples

200

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

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...

Request

path Parameters

inbound_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

delete/v3/automations/sms/inbound/{inbound_rule_id}

Request samples

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

Response samples

200

application/json

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

View SMS Delivery Receipt Rules

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...

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/automations/sms/receipts

Request samples

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

Response samples

200

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": [{"receipt_rule_id": 5,
"rule_name": "My Rule",
"match_type": 0,
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 0
},
{"receipt_rule_id": 6,
"rule_name": "My Rule",
"match_type": 0,
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1
},
{"receipt_rule_id": 7,
"rule_name": "My Rule",
"match_type": 0,
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1
},
{"receipt_rule_id": 8,
"rule_name": "My Rule",
"match_type": 0,
"action": "SMS",
"action_address": "+61298441484",
"enabled": 1
},
{"receipt_rule_id": 9,
"rule_name": "My Rule",
"match_type": 0,
"action": "URL",
"action_address": "+61298441485",
"enabled": 1
}
]
}
}

Create SMS Delivery Receipt Rule

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...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/automations/sms/receipts

Request samples

application/json

{"rule_name": "My Rule",
"match_type": 1,
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1
}

Response samples

200

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

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...

Request

path Parameters

receipt_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/automations/sms/receipts/{receipt_rule_id}

Request samples

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

Response samples

200

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

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...

Request

path Parameters

receipt_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

put/v3/automations/sms/receipts/{receipt_rule_id}

Request samples

application/json

{"rule_name": "My Rule",
"match_type": 1,
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1
}

Response samples

200

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

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...

Request

path Parameters

receipt_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

delete/v3/automations/sms/receipts/{receipt_rule_id}

Request samples

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

Response samples

200

application/json

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