SMS Contacts List

You can query, add, delete and update contact list through following interfaces.


Query contact list

Return to SMS contact list

URL

https://api.sendcloud.net/smsapi/smsContactList/list

HTTP Request Method

post    get

Parameter Description

parameter type required or not description
smsUser string yes smsUser
contactListName string no contact list name
start Integer no start position, [0-], defaults to 0
limit Integer no amount, [0-100],defaults to 100
signature string yes signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/smsContactList/list?smsUser=***&contactName=***&signature=***

Returned value description

parameter description
contactListId contact list ID
contactListName contact list name
description description
memberCount number of contact list members
createTime time of creating contact list
updateTime time of updating contact list

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "查询成功",
    "info": {
        "total": 6,
        "count": 6,
        "contactLists": [{
                "contactListId": 998,
                "contactListName": "test",
                "createTime": "2016-05-10 15:18:38",
                "description": "测试",
                "memberCount": 4,
                "updateTime": "2016-05-11 10:04:20"
            }, {
                "contactListId": 999,
                "contactListName": "test2",
                "createTime": "2016-06-29 12:54:59",
                "description": "test",
                "memberCount": 1,
                "updateTime": "2016-06-29 12:54:59"
            }
        ]
    }
}

Add contact list

Return to added contact list

URL

https://api.sendcloud.net/smsapi/smsContactList/save

HTTP Request Method

post    get

Parameter Description

parameter type required or not description
smsUser string yes smsUser
contactListName string yes contact list name
description string no description
signature string yes signature, validity verification

Request example

https://api.sendcloud.net/smsapi/smsContactList/save?smsUser=***&contactName=***&description=***&signature=***

Returned value description

parameter description
contactListId contact list ID
contactListName contact list name
description description
memberCount number of contact list members
createTime time of creating contact list
updateTime time of updating contact list

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "保存成功",
    "info": {
        "contact": {
            "contactListId": 40,
            "contactListName": "test_3",
            "createTime": "2017-05-19 10:17:03",
            "description": "添加联系人列表测试",
            "memberCount": 0,
            "updateTime": "2017-05-19 10:17:03"
        }
    }
}

Update contact list

Return to updated contact list

URL

https://api.sendcloud.net/smsapi/smsContactList/update

HTTP Request Method

post    get

Parameter Description

parameter type required or not description
smsUser string yes smsUser
contactListName string yes old name of contact list
newContactListName string yes new name of contact list
description string no description
signature string yes signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/smsContactList/update?smsUser=***&contactName=***&newContactName=***&signature=***

Returned value description

parameter description
contactListId contact list ID
contactListName contact list name
description description
memberCount number of contact list members
createTime time of creating contact list
updateTime time of updating contact list

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "更新成功",
    "info": {
        "contact": {
            "contactListId": 35,
            "contactListName": "test",
            "createTime": "2016-08-02 14:06:10",
            "description": "hello",
            "memberCount": 28,
            "updateTime": "2017-05-19 10:55:24"
        }
    }
}

Delete contact list

Return to check if the request has been submitted

URL

https://api.sendcloud.net/smsapi/smsContactList/delete

HTTP Request Method

post    get

Parameter Description

parameter type required or not description
smsUser string yes smsUser
contactListName string yes contact list ID
signature string yes signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/smsContactList/delete?smsUser=***&contactName=***&signature=***

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "删除联系人列表和对应的成员成功",
    "info": {}
}