Skip to content
Messaging
/
Message Delivery

Message Delivery

Everything about Delivery Issues

Download OpenAPI description
message-delivery.json
message-delivery.yaml
Languages
Servers

https://rest.clicksend.com/

Get All Delivery Issues

Request

Get all delivery issues

Get all delivery issues

Parameters

ParameterInTypeRequiredDescription
pagequeryinteger(int32)falsePage number
limitqueryinteger(int32)falseNumber of records per page

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

This endpoint requires authentication,more info...
Security
basicAuth
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/delivery-issues'

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: "Here is your result."
dataobject
Response
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": [ … ]
  }
}

Create Delivery Issues

Request

Create delivery Issue

Create delivery Issue

Properties

NameTypeRequiredRestrictionsDescription
message_idstringfalsenoneThe message id of the message.
typestringtruenoneThe type of message, must be one of the following values SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST.
descriptionstringtruenoneThe description of the message.
client_commentsstringfalsenoneThe user's comments.
email-addressstringtruenoneThe user's email address.

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

This endpoint requires authentication,more info...
Security
basicAuth
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
message_idstring
Example: "{{message_id}}"
typestring
Example: "EMAIL_MARKETING"
descriptionstring
Example: "test"
email_addressstring
Example: "test@test.com"
client_commentsstring
Example: "test"
support_commentsstring
Example: "test"
resolvedboolean
Example: true
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
  \"message_id\": \"B388828B-AD46-4366-8AD3-0305FF5E3FE5\",
  \"type\": \"SMS\",
  \"description\": \"This is a test\",
  \"client_comments\": \"test\",
  \"email_address\": \"john_doe@user.com\"
}" \
'https://rest.clicksend.com/v3/delivery-issues'

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: "New delivery issue has been created."
dataobject
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New delivery issue has been created.",
  "data": {
    "issue_id": 1,
    "user_id": 3820,
    "message_id": "B388828B-AD46-4366-8AD3-0305FF5E3FE5",
    "type": "sms",
    "description": "this is a test.",
    "date_added": 1481610495,
    "email_address": "test@user.com"
  }
}