Skip to content

短信记录查询

momi00 edited this page Jul 1, 2024 · 6 revisions

简要描述:

  • 短信记录查询。只支持查询最近31天的短信记录,请及时查询。如需要全量短信记录维护,也可以使用回执回调功能,自动接收数据并保存。

请求方式:

  • URL:http://api2.nxcloud.com/api/sms/getSmsCdr
  • Method:POST
  • Content-Type:application/x-www-form-urlencoded

参数:

参数名 必选 类型 说明
appkey string 短信应用appkey
secretkey string 短信应用secretkey
date string 日期(yyyyMMdd)
page_size string 数量 (小于1000条)
page string 起始页
sort_type string 排序类型: 0=升序,1=降序;默认为0

请求示例:

curl --location --request POST 'http://api2.nxcloud.com/api/sms/getSmsCdr' \
--data-urlencode 'appkey=asdf' \
--data-urlencode 'secretkey=qwer' \
--data-urlencode 'date=20230202' \
--data-urlencode 'page_size=10' \
--data-urlencode 'page=1'

返回示例

{
	"code": "0",
	"info": {
			"total": 1119,
			"page": 112,
			"pageSize": 2,
			"rows": [
				{
					"senderid": "",
					"body": "hello sms test 001.",
					"phone": "62833935195",
					"msgid": "5cd1397f-f3b2-95de-ed5e-27d5f39a230d",
					"dr_status": "Success",
					"billing_size": 2,
					"billing_price": 0.09,
					"date": "2019-06-15 23:40:00",
					"dr_time": "2019-06-15 23:42:00",
					"billing_status": "Billed",
					"network": 893,
					"dr":"DELIVRD"
				},
				{
					"senderid": "",
					"body": "hello sms test 002.",
					"phone": "62844049494",
					"msgid": "f76bc33281124f8aa8bca33ce54b01ad",
					"dr_status": "Success",
					"billing_size": 2,
					"billing_price": 0.09,
					"date": "2019-06-15 23:50:04",
					"dr_time": "2019-06-15 23:53:00",
					"billing_status": "Billed",
					"network": 791,
					"dr":"DELIVRD"
				}
				]
		}
}

返回参数说明

参数名 类型 说明
code string 接口返回值
senderid string 短信senderid
body string 短信内容
phone string 目标号码, 带国家号
msgid string 短信id
dr_status string 提交状态(Success:成功, Fail:失败)
billing_size number 计费条数
billing_price number 计费单价
date string 发送日期
dr_time string dr日期
billing_status string 计费状态(Billed:已计费, UnBilled:未计费)
network string 运营商
dr string 运营商回执

备注

  • 错误代码
code 说明
0 success
1 params invalid
2 keys invalid
3 page_size or page_index invalid
4 page_size or page_index invalid
5 api request times invalid

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally