AppPush
WebPush
WhatsApp
Email
SMS
OTP
联系人列表
最新更新：2023-04-10
通过以下接口可以对短信联系人列表进行查询, 添加, 删除, 更新操作.
查询联系人列表
返回短信短信联系人列表的基本信息
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
此代码块在浮窗中显示
HTTP请求方式
GET
GET
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| offset | Integer | 否 | 查询起始位置，取值区间 [0-]，默认为 0 |
| limit | Integer | 否 | 查询个数， 取值区间 [0-100]， 默认为 100 |
| contact_list_name | string | 否 | 联系人列表名称，模糊查询 |
请求示例
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| contact_list_id | 联系人列表ID |
| contact_list_name | 联系人列表名称 |
| description | 描述 |
| member_count | 成员个数 |
| create_time | 创建时间 |
| update_time | 更新时间 |
响应示例
{
"result": [{
"contact_List_id": 998,
"contact_list_name": "test",
"description": "",
"member_count": 4,
"create_time": "2016-05-10T15:18:38+0800",
"update_time": "2016-05-11T10:04:20+0800"
},
{
"contact_List_id": 999,
"contact_list_name": "test2",
"description": "",
"member_count": 1,
"create_time": "2016-06-29T12:54:59+0800",
"update_time": "2016-06-29T12:54:59+0800"
}
],
"count":2
"total": 10
}
{
"result": [{
"contact_List_id": 998,
"contact_list_name": "test",
"description": "",
"member_count": 4,
"create_time": "2016-05-10T15:18:38+0800",
"update_time": "2016-05-11T10:04:20+0800"
},
{
"contact_List_id": 999,
"contact_list_name": "test2",
"description": "",
"member_count": 1,
"create_time": "2016-06-29T12:54:59+0800",
"update_time": "2016-06-29T12:54:59+0800"
}
],
"count":2
"total": 10
}
此代码块在浮窗中显示
添加联系人列表
返回添加成功的联系人列表信息
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
此代码块在浮窗中显示
HTTP请求方式
POST
POST
此代码块在浮窗中显示
Content-type
application/json
application/json
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| contact_list_name | string | 是 | 联系人列表名称，仅支持数字、字母、下划线或横线，最长48字符 |
| description | string | 否 | 描述信息，最长255字符 |
请求示例
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "beijing",
"description": "test"
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "beijing",
"description": "test"
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| contact_list_id | 联系人列表ID |
| contact_list_name | 联系人列表名称 |
| description | 列表描述 |
| member_count | 成员个数 |
| create_time | 创建时间 |
| update_time | 更新时间 |
响应示例
Response-success
HTTP Status: 200
{
"result": {
"contact_list_id": 35,
"contact_list_name": "beijing",
"description": "test",
"member_count": 28,
"create_time": "2016-08-02T14:06:10+0800",
"update_time": "2017-05-19T10:55:24+0800"
}
}
{
"result": {
"contact_list_id": 35,
"contact_list_name": "beijing",
"description": "test",
"member_count": 28,
"create_time": "2016-08-02T14:06:10+0800",
"update_time": "2017-05-19T10:55:24+0800"
}
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
// 失败的返回结果示例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// 失败的返回结果示例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
此代码块在浮窗中显示
更新联系人列表
返回更新成功的联系人列表的基本信息
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
此代码块在浮窗中显示
HTTP请求方式
PUT
PUT
此代码块在浮窗中显示
Content-type
application/json
application/json
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| contact_list_name | string | 否 | 联系人列表名称，仅支持数字、字母、下划线或横线，最长48字符 |
| description | string | 否 | 描述信息，最长255字符 |
注意： 1.更新列表的 contact_list_name 和 description时，才会更新列表时间，更新成员时不更新列表更新时间。
请求示例
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "shanghai",
"description": "222"
}'
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "shanghai",
"description": "222"
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| count | 成功修改的个数 |
响应示例
Response-success
HTTP Status: 200
{
"count":1
}
{
"count":1
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
// 失败的返回结果示例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// 失败的返回结果示例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
此代码块在浮窗中显示
删除联系人列表
返回是否提交成功的基本信息
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
此代码块在浮窗中显示
HTTP请求方式
DELETE
DELETE
此代码块在浮窗中显示
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
请求示例
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
此代码块在浮窗中显示
响应示例
| 字段 | 说明 |
|---|---|
| count | 成功删除的个数 |
响应示例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
此代码块在浮窗中显示
通过以下接口可以对短信联系人列表的成员进行查询, 添加, 删除, 更新操作.
查询联系人列表成员
返回短信联系人列表成员的基本信息
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
此代码块在浮窗中显示
HTTP请求方式
GET
GET
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| offset | Integer | 否 | 查询起始位置，取值区间 [0-]，默认为 0 |
| limit | Integer | 否 | 查询个数，取值区间 [0-100]，默认为 100 |
| phone | string | 否 | 成员电话，支持模糊查询 |
| member_ids | string | 否 | 成员ID多个用;号分隔，最多100个 |
请求示例
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| member_id | 成员ID |
| phone | 成员电话 |
| name | 成员名称 |
| vars | 变量 |
| create_time | 创建时间 |
| update_time | 更新时间 |
响应示例
{
"result": [
{
"member_id": 440164,
"phone": "18********",
"name": "",
"vars": "{'beizhu':'hello'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
},
{
"member_id": 440964,
"phone": "13********",
"name": "",
"vars": "{'beizhu':'ss'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"member_id": 440164,
"phone": "18********",
"name": "",
"vars": "{'beizhu':'hello'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
},
{
"member_id": 440964,
"phone": "13********",
"name": "",
"vars": "{'beizhu':'ss'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
}
],
"total": 2,
"count": 2
}
此代码块在浮窗中显示
添加联系人列表成员
添加联系人列表成员
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
此代码块在浮窗中显示
HTTP请求方式
POST
POST
此代码块在浮窗中显示
Content-type
application/json
application/json
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| members | Array [object] | 是 | 联系人列表成员，最多1000个成员 |
| phone | string | 是 | 成员电话，国际手机号格式 |
| name | string | 否 | 成员名称，最长48字符 |
| vars | object | 否 | 变量，最大不超过1KB |
注意:
- 添加 vars 变量，注意 key 不需要 带上 '%'，key长度不得超过32个字符
- vars 变量中， key 为 name 的变量会被参数 name 覆盖
请求示例
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"members": [
{
"phone": "+86158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
},
{
"phone": "+8618754265414",
"name": "aaa",
"vars": {"sex":"female","code":"2"}
}
]
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"members": [
{
"phone": "+86158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
},
{
"phone": "+8618754265414",
"name": "aaa",
"vars": {"sex":"female","code":"2"}
}
]
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| count | 添加成功的成员数 |
| invalid | 添加失败的成员 |
响应示例
Response-success
HTTP Status: 200
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
此代码块在浮窗中显示
更新联系人列表成员
更新联系人列表成员
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}}/members/{member_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}}/members/{member_id}
此代码块在浮窗中显示
HTTP请求方式
PUT
PUT
此代码块在浮窗中显示
Content-type
application/json
application/json
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| member | Object | 是 | 联系人列表成员 |
| phone | string | 否 | 成员电话，国际号码格式 |
| name | string | 否 | 成员名称，最长48字符 |
| vars | object | 否 | 变量，最大不超过1KB，key长度不超过32个字符 |
请求示例
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"member":
{
"phone": "158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"member":
{
"phone": "158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
}
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| count | 成功更新记录数 |
响应示例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
此代码块在浮窗中显示
删除联系人列表成员
返回是否删除成功
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
此代码块在浮窗中显示
HTTP请求方式
DElETE
DElETE
此代码块在浮窗中显示
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
此代码块在浮窗中显示
Request-Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
请求示例
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| count | 成功删除记录数 |
响应示例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
// 失败的返回结果示例
{
"code": 35002,
"message": "The contact_list_id does not exist"
}
此代码块在浮窗中显示
