Automations

Create Voice Delivery Receipt Rule

Voice

Everything about Voice Delivery Receipt Automations

Servers

https://rest.clicksend.com/

View Voice Delivery Receipt Rules

Request

Get all voice delivery receipt automations

Get all voice 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/voice/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 voice receipts."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your voice receipts.",
  "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 Voice Delivery Receipt Rule

Request

Create voice delivery receipt automations

Create voice 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: "test"

match_typeinteger

Example: 1

actionstring

Example: "URL"

action_addressstring

Example: "http://test.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/voice/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 voice receipt has been added."

dataobject(voice_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your new voice receipt has been added.",
  "data": {
    "receipt_rule_id": 2,
    "rule_name": "My Rule 2",
    "match_type": 3,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

View Voice Delivery Receipt Rule

Request

Get specific voice delivery receipt automation

Get specific voice 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/voice/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(voice_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming voice receipt.",
  "data": {
    "receipt_rule_id": 2,
    "rule_name": "My Rule 2",
    "match_type": 3,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

Update Voice Delivery Receipt Rule

Request

Update voice delivery receipt automation

Update voice 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: "test"

match_typeinteger

Example: 1

actionstring

Example: "URL"

action_addressstring

Example: "http://test.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/voice/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(voice_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming voice receipt.",
  "data": {
    "receipt_rule_id": 2,
    "rule_name": "My Rule 2",
    "match_type": 3,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

Delete Voice Delivery Receipt Rule

Request

Delete voice delivery receipt automation

Delete voice 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/voice/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 voice receipt has been deleted."

dataArray of items

Example: []

Response

application/json

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

Voice

View Voice Delivery Receipt Rules

Request

Parameters

Responses

Was this helpful?

Create Voice Delivery Receipt Rule

Request

Properties

Responses

Was this helpful?

View Voice Delivery Receipt Rule

Request

Parameters

Responses

Was this helpful?

Update Voice Delivery Receipt Rule

Request

Parameters

Properties

Responses

Was this helpful?

Delete Voice Delivery Receipt Rule

Request

Parameters

Responses

Was this helpful?