ClickSend

SMS and Voice message support within A-Op via ClickSend integration.

Actions

ClickSend SMS

Send an SMS message to a recipient.

Input

Name Description Type Required Syntax
Username Your ClickSend username. input True True
Password Your ClickSend API password. password-input True True
Recipient Phone number of the person you you want to send the message to. input True True
Message Message that you want to send. input True True
Process Receipt When True and a receipt is received the flow will re-trigger and return a 205 result code from this action. group-checkbox False False
Require Input When True and a recipient reply is received the flow will re-trigger and return a 205 result code along with the message reply from this action. checkbox False False
Expiry How long to wait for a receipt or reply to a message. When Process Receipt is enabled and the expiry elapses the flow is re-triggers and return a 404 from this action. input False False
maxDuration Max duration to apply when re-triggering post a receipt being received. input False False
Restore Full Data When True the full flow data will be retained and preserved when re-triggering the flow. Otherwise the data within Restore Data will be used. checkbox False False
Restore Data When Restore Full Data is not checked then the data within this field will be used and restored into a flowData var called data when the flow is re-triggered. json-input False True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successfully posted a message to ClickSend to deliver."}}
rc Returns the exit code for the action. number True {"200": {"description": "Successfully posted a message to ClickSend to deliver."}, "201": {"description": "Message delivered to the handset."}, "205": {"description": "Input has been provided."}, "209": {"description": "Successfully posted a message to ClickSend to deliver. However it was not possible to register for receipt processing at this time."}, "404": {"description": "Receipt has expired without a receipt being seen."}}
response Response from the ClickSend API when sending a message. json True {}

ClickSend Voice

Send an voice message to a recipient.

Input

Name Description Type Required Syntax
Username Your ClickSend username. input True True
Password Your ClickSend API password. password-input True True
Recipient Phone number of the person you you want to send the message to. input True True
Message Message that you want to send. input True True
Process Receipt When True and a receipt is received the flow will re-trigger and return a 205 result code from this action. group-checkbox False False
Require Input When True the phone call will wait for input and then this flow will re-trigger and return a 205 result code from this action along with the input key provided. checkbox False False
Expiry How long to wait for a receipt or reply to a message. When Process Receipt is enabled and the expiry elapses the flow is re-triggers and return a 404 from this action. input False False
maxDuration Max duration to apply when re-triggering post a receipt being received. input False False
Restore Full Data When True the full flow data will be retained and preserved when re-triggering the flow. Otherwise the data within Restore Data will be used. checkbox False False
Restore Data When Restore Full Data is not checked then the data within this field will be used and restored into a flowData var called data when the flow is re-triggered. json-input False True
Leave Message When True ClickSend will detect answerphone and leave a message. checkbox False False
Language What language and accent to use. dropdown True False
voice Female or Male voice when reading back the message. dropdown True False

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successfully posted a message to ClickSend to deliver."}}
rc Returns the exit code for the action. number True {"200": {"description": "Successfully posted a message to ClickSend to deliver."}, "205": {"description": "Called completed or input has been provided."}, "209": {"description": "Successfully posted a message to ClickSend to deliver. However it was not possible to register for receipt processing at this time."}, "404": {"description": "Receipt has expired without a receipt being seen."}}
response Response from the ClickSend API when sending a message. json True {}

clicksendProcessReceipts

Input

Name Description Type Required Syntax
Username Your ClickSend username. input True True
Password Your ClickSend API password. password-input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}}
sms_receipts_outstanding Number of sms receipts outstanding. number True {}
sms_messages_outstanding Number of sms receipts requiring input outstanding. number True {}
Voice_receipts_outstanding Number of voice receipts outstanding. number True {}

Guide of how to use ClickSend: Guide Page