SMS Contact Task

You can send the task of SMS contact list and query the task status through the following interfaces.


Send the task of SMS contact list

Return to the task of SMS contact list

URL

https://api.sendcloud.net/smsapi/sendContactListTask

HTTP Request Method

post    get

Parameter Description

parameter type required or not description
smsUser string yes smsUser
contactListName string yes name of the contact list
taskName string yes task name
senderName string no sender name
templateId Integer yes SMS template ID
executeTime String no execute time of the task, formatted as yyyy-MM-dd HH:mm:ss
signature string yes signature, validity verification

Tips:

  1. 1.If you want to execute the SMS task at a specified time, you need to input the executeTime; otherwise, it defaults to an immediate execution.

Request Example

https://api.sendcloud.net/smsapi/sendContactListTask?smsUser=***&contactName=***&taskName=***&senderName=***&templateId=***&signature=***

Returned value description

parameter description
taskId task ID
contactListName name of the contact list
taskName task name
senderName sender name
templateId SMS template ID
memberCount number of the members in the task
status status of SMS
createTime time of creating the task
endTime end time of the task

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "联系人列表任务保存成功",
    "info": {
        "smsTask": {
            "contactListName": "test",
            "createTime": "2017-05-19 14:22:57",
            "endTime": "",
            "memberCount": 4,
            "senderName": "sendcloud",
            "status": "等待执行",
            "taskId": 472,
            "taskName": "test",
            "templateId": 999
        }
    }
}

Query the task of SMS contact list

Return to the task of SMS contact list

URL

https://api.sendcloud.net/smsapi/queryContactListTask

HTTP请求方式

post    get

HTTP Request Method

parameter type required or not description
smsUser string yes smsUser
taskId Integer yes task ID
signature string yes signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/queryContactListTask?smsUser=***&taskId=***&signature=***

Returned value description

parameter description
taskId task ID
contactListName name of the contact list
taskName task name
senderName sender name
templateId SMS template ID
memberCount number of the members in the task
status status of SMS
createTime time of creating the task
endTime end time of the task

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "查询成功",
    "info": {
        "smsTask": {
            "contactListName": "test",
            "createTime": "2017-05-19 14:22:57",
            "endTime": "",
            "memberCount": 4,
            "senderName": "sendcloud",
            "status": "等待执行",
            "taskId": 472,
            "taskName": "test",
            "templateId": 999
        }
    }
}