Fax (1.0.0)

Everything about FAX Delivery Receipt Automations

View Fax Inbound Rules

Get all inbound fax automations

Get all inbound fax 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/fax/inbound

Request samples

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

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound fax.",
"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": [{"inbound_rule_id": 1,
"dedicated_number": 19,
"rule_name": "Email",
"user_id": "1",
"action": "EMAIL_FIXED",
"action_address": "test@test.com",
"enabled": "1"
},
{"inbound_rule_id": 2,
"dedicated_number": 19,
"rule_name": "URL",
"user_id": "1",
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": "0"
}
]
}
}

Create Fax Inbound Rule

Create new inbound fax automation

Create new inbound fax automation

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.
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/fax/inbound

Request samples

application/json

{"dedicated_number": "*",
"rule_name": "test rule",
"action": "URL",
"action_address": "https://testzzz.com",
"enabled": 1
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New rule has been added.",
"data": {"inbound_rule_id": 1,
"dedicated_number": "19",
"rule_name": "Email",
"user_id": 1,
"action": "EMAIL_FIXED",
"action_address": "test@test.com",
"enabled": 1
}
}

View Fax Inbound Rule

Get specific inbound fax automation

Get specific inbound fax 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/fax/inbound/{inbound_rule_id}

Request samples

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

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound fax.",
"data": {"inbound_rule_id": 1,
"dedicated_number": "19",
"rule_name": "Email",
"user_id": 1,
"action": "EMAIL_FIXED",
"action_address": "test@test.com",
"enabled": 1
}
}

Update Fax Inbound Rule

Update inbound fax automation

Update inbound fax 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.
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

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/fax/inbound/{inbound_rule_id}

Request samples

application/json

{"dedicated_number": "+61411111111",
"rule_name": "test rule",
"action": "URL",
"action_address": "https://testzzz.com",
"enabled": 1
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound fax.",
"data": {"inbound_rule_id": 1,
"dedicated_number": "19",
"rule_name": "Email",
"user_id": 1,
"action": "EMAIL_FIXED",
"action_address": "test@test.com",
"enabled": 1
}
}

Delete Fax Inbound Rule

Delete inbound fax automation

Delete inbound fax 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/fax/inbound/{inbound_rule_id}

Request samples

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

Response samples

200

application/json

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

View FAX Delivery Receipt Rules

Get all fax delivery receipt automations

Get all fax 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/fax/receipts

Request samples

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

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result.",
"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": 1,
"rule_name": "Email Test Rule",
"match_type": 0,
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1
},
{"receipt_rule_id": 2,
"rule_name": "test",
"match_type": 0,
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1
}
]
}
}

Create FAX Delivery Receipt Rule

Create fax delivery receipt automations

Create fax 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/fax/receipts

Request samples

application/json

{"rule_name": "test",
"match_type": 0,
"action": "URL",
"action_address": "https://testzzz.com",
"enabled": 1,
"url": "http://yourUrl.com"
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your new Fax receipt has been added.",
"data": {"receipt_rule_id": 1,
"rule_name": "Email Test Rule",
"match_type": 0,
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1
}
}

View FAX Delivery Receipt Rule

Get specific fax delivery receipt automation

Get specific fax 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/fax/receipts/{receipt_rule_id}

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/email/receipt/{rule_id}'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming fax receipt.",
"data": {"receipt_rule_id": 1,
"rule_name": "Email Test Rule",
"match_type": 0,
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1
}
}

Update FAX Delivery Receipt Rule

Update fax delivery receipt automation

Update fax 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/fax/receipts/{receipt_rule_id}

Request samples

application/json

{"action_address": "test.com"
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming fax receipt has been updated.",
"data": {"receipt_rule_id": 1,
"rule_name": "Email Test Rule",
"match_type": 0,
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1
}
}

Delete FAX Delivery Receipt Rule

Delete fax delivery receipt automation

Delete fax 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/fax/receipts/{receipt_rule_id}

Request samples

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

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming fax receipt has been deleted.",
"data": null
}