Skip to main content

短信接口(cc)

如何认证

示例

  1. 获取Token
  2. 在Header里添加 Authorization: Bearer {ACCESS_TOKEN}

短信签名列表接口

短信签名列表接口查询

接口地址

POST https://openapi.icsoc.net/ektv3/sms/sign/list

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
pageint当前页否
rowsint当前页大小, 默认100,最大500否
sign_textstring签名内容 模糊查询否
stateint签名状态 0审核中，1审核通过，2审核未通过否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/sign/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "page":1,
    "rows":10,
    "state":1
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "6pH4I0VuJqi1IAFHdfFykoSbALMKD0zZ",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1037,
                "vcc_id": 782,
                "sign_id": 59,
                "sign_text": "测试签名test",
                "add_time": "2023-09-27 16:35:10",
                "add_user": "5012 孙文娟测试测试8",
                "state": 1,
                "reason": "",
                "remark": "",
                "is_used": false,
                "state_name": "审核通过"
            }
        ],
        "first_page_url": "https://openapi.icsoc.net/ektv3/sms/sign/list?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://openapi.icsoc.net/ektv3/sms/sign/list?page=1",
        "next_page_url": null,
        "path": "https://openapi.icsoc.net/ektv3/sms/sign/list",
        "per_page": 100,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

响应字段说明

参数类型描述
idint签名 id
vcc_idint企业id
sign_idint短信平台 签名id
sign_textstring签名内容
add_timestring添加时间
add_userstring添加人
stateint签名状态 0审核中，1审核通过，2审核未通过
reasonstring未审核通过原因说明
remarkstring备注
is_usedbool是否被短信模板引用
state_namestring签名状态说明

短信签名添加接口

添加短信签名

接口地址

POST https://openapi.icsoc.net/ektv3/sms/sign/store

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
sign_textstring签名内容是
remarkstring备注否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/sign/store' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "sign_text": "test签名",
    "remark": "备注"
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "3TPgySoYtDHINBHS1tURAst6ls4DCrlm",
    "data": {
      "sign_text": "test签名2",
      "remark": "备注",
      "vcc_id": 782,
      "sign_id": 75,
      "state": 1,
      "add_user": "test 测试",
      "add_time": "2024-03-11 17:00:07",
      "id": 1053
    }
}

响应字段说明

参数类型描述
idint签名 id
vcc_idint企业id
sign_idint短信平台 签名id
sign_textstring签名内容
add_timestring添加时间
add_userstring添加人
stateint签名状态 0审核中，1审核通过，2审核未通过
remarkstring备注

短信签名删除接口

删除短信签名

接口地址

POST https://openapi.icsoc.net/ektv3/sms/sign/delete

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
idsarray签名ID是

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/sign/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "ids": [
        1,
        2
    ]
}'

响应

{
  "code": 0,
  "message": "success",
  "request_id": "YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP",
  "data": {
    "success": [
      {
        "id": 1,
        "sign_text": "签名1"
      },
      {
        "id": 2,
        "sign_text": "签名2"
      }
    ],
    "error": []
  }
}

响应字段说明

参数类型描述
successobject[]成功号码说明
errorobject失败号码说明

短信模板列表接口

短信模板列表接口查询

接口地址

POST https://openapi.icsoc.net/ektv3/sms/template/list

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
pageint当前页否
rowsint当前页大小, 默认100,最大500否
dept_idint所属部门id否
keywordstring模板名称否
idsstring模板id 多个英文逗号隔开否
stateint模板状态 -1 草稿，0审核中，1审核通过，2审核未通过否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/template/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "page":1,
    "rows":10,
    "state":1
}'

响应

{
  "code": 0,
  "message": "success",
  "request_id": "bQ3RdWVGQTSGg8McyrE7CLJ5lCpKpzaL",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 4797,
        "vcc_id": 782,
        "tpl_id": 150,
        "tpl_title": "视频客服tsx01",
        "tpl_type": 2,
        "tpl_text": "请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向客服发起视频通话请>>${小程序链接}<<打开微信小程序，向服发起视频通话向服发起视频通话向",
        "new_sign_id": 1008,
        "sign_text": "测试签名",
        "state": 1,
        "reason": "",
        "remark": "",
        "dept_id": 1,
        "dept_name": "公司",
        "verify_result": 1,
        "state_name": "审核通过",
        "tpl_type_name": "通知类",
        "dept_name_chain": "公司",
        "tpl_param": [
          "小程序链接"
        ]
      }
    ],
    "first_page_url": "https://openapi.icsoc.net/ektv3/sms/template/list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://openapi.icsoc.net/ektv3/sms/template/list?page=1",
    "next_page_url": null,
    "path": "https://openapi.icsoc.net/ektv3/sms/template/list",
    "per_page": 10,
    "prev_page_url": null,
    "to": 1,
    "total": 1
  }
}

响应字段说明

参数类型描述
idint模板 id 发送短信时用
vcc_idint企业id
tpl_idint短信平台模板ID 用于搜索短信记录
tpl_titlestring模板名称
tpl_textstring模板内容
tpl_typeint模板类型 1验证码 2通知 3营销
new_sign_idint签名ID
sign_textstring签名内容
stateint状态码 -1草稿 0待审核 1审核通过 2审核不通过
reasonstring审核不通过原因
remarkstring备注
dept_idint所属部门ID
dept_namestring所属部门名称
state_namestring状态结果说明
tpl_type_namestring模板类型说明
dept_name_chainstring部门层级链条名称
tpl_paramarray模板变量参数

短信模板添加接口

添加短信模板

接口地址

POST https://openapi.icsoc.net/ektv3/sms/template/store

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
template_namestring模板名称是
template_contentsstring模板内容是
sign_idint签名ID是
dept_idint所属部门ID否
actionint动作1:保存草稿,2:提交审核,默认为2否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/template/store' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "template_name": "测试接口添加",
    "template_contents": "UpUpUpUpUpUp${url}",
    "sign_id": 1008,
    "dept_id": 0,
    "action": 1
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "kTVXeyblZpDGYao0wEY0duWbcOnyMaAC",
    "data": {
        "vcc_id": 782,
        "tpl_title": "测试接口添加",
        "tpl_text": "UpUpUpUpUpUp${url}",
        "new_sign_id": 1008,
        "sign_text": "测试签名",
        "dept_id": 0,
        "dept_name": "",
        "state": -1,
        "tpl_id": 168,
        "is_del": 0,
        "app_id": "ekt",
        "add_user_id": 1024437,
        "update_user_id": 1024437,
        "add_user": "tt xx",
        "add_time": "2024-03-11 15:11:54",
        "update_time": "2024-03-11 15:11:54",
        "update_name": "test xx",
        "id": 4815
    }
}

响应字段说明

参数类型描述
idint模板 id 发送短信时用
vcc_idint企业id
tpl_titlestring模板名称
tpl_textstring模板内容
new_sign_idint签名ID
sign_textstring签名内容
dept_idint所属部门ID
dept_namestring所属部门名称
stateint状态码 -1草稿 0待审核 1审核通过 2审核不通过
tpl_idint短信平台模板ID 用于搜索短信记录
add_user_idint添加人ID
update_user_idint修改人ID
add_userstring添加改人名称
add_timestring添加时间
update_timestring修改时间
update_namestring修改人名称

短信模板修改接口

修改短信模板

接口地址

POST https://openapi.icsoc.net/ektv3/sms/template/update

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
template_idint模板ID是
template_namestring模板名称是
template_contentsstring模板内容是
sign_idint签名ID是
dept_idint所属部门ID否
actionint动作1:保存草稿,2:提交审核,默认为2否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/template/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "template_id":4815,
    "template_name": "测试接口修改",
    "template_contents": "UpUpUpUpUpUp${url}修改test",
    "sign_id": 1008,
    "dept_id": 0,
    "action": 2
}'

响应

{
  "code": 0,
  "message": "success",
  "request_id": "SeIczlgmvYvl4u8dL16ZCYXuT8BCpMOg",
  "data": {
    "id": 4815,
    "vcc_id": 782,
    "tpl_id": 168,
    "tpl_title": "测试接口修改",
    "tpl_type": null,
    "tpl_text": "UpUpUpUpUpUp${url}修改testxxxx",
    "new_sign_id": 1008,
    "sign_text": "测试签名",
    "add_time": "2024-03-11 15:11:54",
    "add_user_id": 1024437,
    "add_user": "test 测试",
    "update_time": "2024-03-11 15:50:40",
    "update_user_id": 1024437,
    "update_name": "test 测试",
    "state": 0,
    "dept_id": 0,
    "dept_name": ""
  }
}

响应字段说明

参数类型描述
idint模板 id 发送短信时用
vcc_idint企业id
tpl_titlestring模板名称
tpl_textstring模板内容
new_sign_idint签名ID
sign_textstring签名内容
dept_idint所属部门ID
dept_namestring所属部门名称
stateint状态码 -1草稿 0待审核 1审核通过 2审核不通过
tpl_idint短信平台模板ID 用于搜索短信记录
add_user_idint添加人ID
update_user_idint修改人ID
add_userstring添加改人名称
add_timestring添加时间
update_timestring修改时间
update_namestring修改人名称

短信模板删除接口

删除短信模板

接口地址

POST https://openapi.icsoc.net/ektv3/sms/template/delete

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
idsarray模板ID是

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/template/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "ids": [
        4815,
        4796
    ]
}'

响应

{
  "code": 0,
  "message": "success",
  "request_id": "3mQnxjiQIL0epJS5i2g10ONjTbHSY0Ww",
  "data": {
    "success": [
      {
        "id": 4815,
        "tpl_title": "测试接口修改"
      },
      {
        "id": 4796,
        "tpl_title": "视频客服邀请短信"
      }
    ],
    "error": []
  }
}

响应字段说明

参数类型描述
successobject[]成功号码说明
errorobject失败号码说明

短信发送记录列表接口

短信发送记录列表接口

接口地址

POST https://openapi.icsoc.net/ektv3/sms/record/list

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
pageint当前页否
rowsint当前页大小, 默认100,最大500否
start_timestring开始时间 yyyy-mm-dd HH:ii:ss否
end_timestring结束时间 yyyy-mm-dd HH:ii:ss否
resultint发送结果 -1:已发送 1:发送成功 0:发送失败否
mobilestring发送手机号否
tpl_idint短信平台模板ID否
sign_idint短信签名ID否
ag_idint发送人用户ID否
dept_idint部门ID否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求


curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/record/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "page":1,
    "rows":10,
    "start_time":"2023-11-01 00:00:00",
    "end_time":"2023-11-30 23:59:59"
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "puj4DNhuJnlQ6xwcmrYdDc1hbV75ompz",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 135301,
                "vcc_id": 782,
                "mobile": "15953371820",
                "tpl_id": 140,
                "sign_id": 8,
                "sms_id": "02fc2a1342a2308dfd986b35c0934d79",
                "sms_params": "{\"占位符\":\"哈哈\"}",
                "sms_text": "【test】公司位置是哈哈",
                "time_add": "2023-11-30 17:04:35",
                "time_send": "2023-11-30 17:04:35",
                "time_delivered": "2023-11-30 17:04:35",
                "result": 0,
                "errmsg": "其他, CMPP20ERR:1",
                "country_code": "86",
                "country_name": "中国",
                "area_code": "0533",
                "area_name": "山东 淄博市",
                "user_id": "1035361",
                "user_data": {
                    "user_name": "1130 饭小小"
                },
                "dept_id": "115483",
                "user_name": "1130 饭小小",
                "tpl_name": "测试短信模板",
                "dept_name": "fxx",
                "dept_name_chain": "公司>fxx",
                "send_time": "2023-11-30 17:04:35",
                "sms_contents": "【test】公司位置是哈哈",
                "sms_result": 3,
                "result_name": "发送失败"
            }
        ],
        "first_page_url": "https://openapi.icsoc.net/ektv3/sms/record/list?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://openapi.icsoc.net/ektv3/sms/record/list?page=1",
        "next_page_url": null,
        "path": "https://openapi.icsoc.net/ektv3/sms/record/list",
        "per_page": 1,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

响应字段说明

参数类型描述
idint主键id
vcc_idint企业id
mobilestring手机号码
tpl_idint短信平台模板id
sign_idint短信签名id
sms_idstring短信平台记录id
sms_paramsstring短信参数
sms_textstring短信内容
time_addstring添加时间
time_sendstring发送时间
time_deliveredstring到达时间
resultint发送结果 -1:已发送 1:发送成功 0:发送失败
errmsgstring失败原因
country_codestring国家码
country_namestring国家名称
area_codestring归属地区号
area_namestring归属地名称
user_idstring发送人id
user_dataobject随路数据
dept_idint部门id
user_namestring发送人名称
tpl_namestring短信模板名称
dept_namestring部门名称
dept_name_chainstring部门链路名称
send_timestring发送时间
result_namestring发送结果名称

短信发送接口

短信发送接口

接口地址

POST https://openapi.icsoc.net/ektv3/sms/send

接口参数

传参方式: Content-Type: application/json

参数类型说明必填
phonestring手机号码 如果是批量发送 使用 "\n" 换行隔开,如果是批量发送且有模板变量,变量和号码用逗号隔开否
typeint1 单个发送 2 批量发送 默认 1否
template_idstring模板ID (template/list接口返回的id)否
sms_paramsobject模板变量参数否

结果编码说明

code说明
0ok
其它具体看message返回信息

示例

请求

单个发送

curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "phone": "18310132161",
    "template_id": 4736,
    "sms_params": {
        "url": "http://www.baidu.com"
    }
}'

批量发送

curl --location --request POST 'https://openapi.icsoc.net/ektv3/sms/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "phone": "18310132161,http://www.baidu.com\n18310132162,http://www.11.com",
    "template_id": 4736,
    "type":2
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "Z5n9HkIC8nyjegzn2JQCBfHSAuBC5bPr",
    "data": {
        "success": {
            "18310132161": "ok"
        },
        "error": {
            "18310132162":"号码格式不正确"
        }
    }
}

响应字段说明

参数类型描述
successobject成功号码说明
errorobject失败号码说明