Email To SMS (1.0.0)

Everything about Email to SMS

View Allowed Emails

Get list of email to sms allowed addresses

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/sms/email-sms
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/sms/email-sms'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here are some data.",
  • "data": [
    ]
}

Add Allowed Email

Create email to sms allowed address

Properties

Name Type Required Restrictions Description
email_address string true none Your email address
from string false yes Your sender id

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/sms/email-sms
Request samples
application/json
{
  • "email_address": "test@test.com",
  • "from": "test",
  • "from_fax": "0411111111",
  • "subaccount_id": "{{subaccountId}}"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "New data has been saved.",
  • "data": {
    }
}

View Stripped String Rules

Get list of email to sms stripped string rules

Get list of email to sms stripped string rules

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/sms/email-sms-stripped-strings
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "New data has been saved.",
  • "data": {
    }
}

Create Stripped String Rule

Create email to sms stripped string rule

Create email to sms stripped string rules

Parameters

Parameter In Type Required Description
stripped-string body string true String to be stripped.

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/sms/email-sms-stripped-strings
Request samples
application/json
{
  • "strip_string": "test"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Strip string has been created.",
  • "data": {
    }
}

View Stripped String Rule

Get email to sms stripped string rule

Get email to sms stripped string rule

Parameters

Parameter In Type Required Description
rule_id path integer(int32) true Your rule id

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

This endpoint requires authentication, more info...
Request
path Parameters
rule_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/sms/email-sms-stripped-strings/{rule_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings/{rule_id}'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here is your result.",
  • "data": {
    }
}

Update Stripped String Rule

Update email to sms stripped string rule

Update email to sms stripped string rule

Parameters

Parameter In Type Required Description
rule_id path integer(int32) true Your rule id
stripped-string body string true String to be stripped.

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

This endpoint requires authentication, more info...
Request
path Parameters
rule_id
required
string
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

put/v3/sms/email-sms-stripped-strings/{rule_id}
Request samples
application/json
{
  • "strip_string": "test"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Strip string has been updated.",
  • "data": {
    }
}

Delete Stripped String Rule

Delete email to sms stripped string rule

Delete email to sms stripped string rule

Parameters

Parameter In Type Required Description
rule_id path integer(int32) true Your rule id

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

This endpoint requires authentication, more info...
Request
path Parameters
rule_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

delete/v3/sms/email-sms-stripped-strings/{rule_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings/{rule_id}'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Strip string has been deleted.",
  • "data": true
}
Copyright © ClickSend 2024. All right reserved.