短信联系人列表成员

通过以下接口可以对短信联系人列表的成员进行查询, 添加, 删除, 修改操作.

查询联系人列表成员

返回短信联系人列表成员的基本信息

URL 

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

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
contactListName string 是 联系人列表名称
phone string 否 成员电话
userName string 否 成员名称
start Integer 否 查询起始位置, 取值区间 [0-], 默认为 0
limit Integer 否 查询个数, 取值区间 [0-100], 默认为 100
signature string 是 数字签名, 合法性验证

请求示例

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

返回值说明

参数 说明
id 成员Id
contactlistId 短信联系人列表Id
phone 成员电话
userName 成员用户名
vars 变量
createTime 创建时间

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "查询成功",
    "info": {
        "total": 102,
        "count": 2,
        "contactMemberList": [{
                "contactlistId": 999,
                "createTime": "2016-10-18 15:13:27",
                "id": 440164,
                "phone": "18********",
                "userName": "",
                "vars": "{\"name\":\"hello\"}"
            }, {
                "contactlistId": 999,
                "createTime": "2016-10-18 15:13:27",
                "id": 440165,
                "phone": "15********",
                "userName": "",
                "vars": "{\"name\":\"world\"}"
            }
        ]
    }
}

添加或者更新联系人列表成员(批量添加手机号)

URL 

https://api.sendcloud.net/smsapi/smsContactListMember/batchSaveOrUpdate

HTTP请求方式

post

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
contactListName string 是 联系人列表名称
phones string 是 成员电话列表(最大100个电话)，以;分割，如：phones=13964578911;13546523897
userNames string 否 成员名称(单个名称最大48个字符)列表，以;分割,对应phones列表的个数和位置。如：userNames=张三;李四
vars string 否 变量(单个变量最大1023个字符)列表，以;分割，对应phones列表的个数和位置。如：vars={"sex":"男","code":"1"};{"sex":"女","code":"2"}
signature string 是 数字签名, 合法性验证

提示:

  1. 若userNames列表有值，则其数据个数(以;分割) 需要与 phones列表的数据个数(以;分割)相同；
  2. 若vars列表有值，则其数据个数(以;分割) 需要与 phones列表的数据个数(以;分割)相同；
  3. 若userNames列表有值，userNames列表中的值与phones列表中的值，他们以;分割后位置是一一对应的；
  4. 若vars列表有值，vars列表中的值与phones列表中的值，他们以;分割后位置是一一对应的；
  5. phone校验不通过，此条记录不入库或不更新
  6. phone校验通过，对应的userName有值，但校验不通过，此条记录不入库或不更新
  7. phone校验通过，对应的var有值，但校验不通过，此条记录不入库或不更新
  8. 当所有记录 命中5、6、7从而造成没有有效的 入库或更新记录时，返回错误给接口调用方

返回值说明

参数 说明
id 成员Id
contactlistId 短信联系人列表Id
phone 成员电话
userName 成员用户名
vars 变量
createTime 创建时间

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "成功",
    "info": {
        "contactMemberList": [
            {
                "contactlistId": 213,
                "createTime": "2021-07-13 16:41:51",
                "id": 4421350,
                "phone": "13546523897",
                "userName": "lisi",
                "vars": "{\"sex\":\"女\"}"
            },
            {
                "contactlistId": 213,
                "createTime": "2021-07-13 16:41:51",
                "id": 4421351,
                "phone": "13964578911",
                "userName": "zhangsan",
                "vars": "{\"sex\":\"男\"}"
            }
        ],
        "count": 2
    }
}

添加或者更新联系人列表成员

返回添加或者更新成员的信息

URL 

https://api.sendcloud.net/smsapi/smsContactListMember/saveOrUpdate

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
contactListName string 是 联系人列表名称
phone string 是 成员电话
userName string 否 成员名称
vars string 是 变量
signature string 是 数字签名, 合法性验证

提示:

  1. 如果phone已经存在，则更新记录，否则插入记录

请求示例

https://api.sendcloud.net/smsapi/smsContactListMember/saveOrUpdate?smsUser=***&contactName=***&phone=***&userName=***&vars=**&signature=***

返回值说明

参数 说明
id 成员Id
contactlistId 短信联系人列表Id
phone 成员电话
userName 成员用户名
vars 变量
createTime 创建时间

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "保存成功",
    "info": {
        "contactMember": {
            "contactlistId": 39,
            "createTime": "2017-05-19 14:09:16",
            "id": 440303,
            "phone": "18971138295",
            "userName": "101",
            "vars": "{101}"
        }
    }
}

删除短信联系人列表成员

返回是否删除成功

URL 

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

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
contactListName string 是 联系人列表名称
phone string 是 成员电话
signature string 是 数字签名, 合法性验证

请求示例

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

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "删除成功",
    "info": {}
}