API中心/查询收件人列表
 
 

查询收件人列表

GET
POST
https://api.itniotech.com/email/getListReceivers?appId={appId}&receiversName={receiversName}
查询平台配置的收件人列表信息。
 
请求参数
appId
String
必填
应用id（邮件-邮件应用）
receiversName
String
收件人列表名称的关键字模糊查询
 
请求示例
//GET请求示例:
Request URL:
    https://api.itniotech.com/email/getListReceivers?appId=bDqJFiq9&receiversName=receiversName
Request Method:
    GET
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9


//POST请求示例:
Request URL:
    https://api.itniotech.com/email/getListReceivers
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "appId":"bDqJFiq9",
    "receiversName":"receiversName"
}
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见邮件响应状态码说明 String
reason 失败原因说明 String
receiverData 以下5个字段数组 Array
receiverId 收件人列表ID Int
receiversName 收件人列表名称 String
count 收件人地址总数 Int
desc 收件人列表描述。注意：此字段可能返回 null，表示取不到有效值。 String
createTime 创建时间 String
 
响应状态码
status 状态说明
0 成功
-1 身份验证错误
-4 用户锁定
-6 时间戳过期
-8 限制IP访问
-23 端口或者程序异常
-24 您的账号未验证，请验证!
查询模板信息
查询发件人

意见反馈

文档内容是否对您有帮助?

 

LANGUAGE

Java

PHP

Curl

Python

REQUEST

import cn.hutool.crypto.SecureUtil;
import cn.hutool.http.Header;
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.json.JSONUtil;

import java.time.LocalDateTime;
import java.time.ZoneId;

public void getListReceivers(){
    final String baseUrl = "https://api.itniotech.com/email";
    final String apiKey = "your api key";
    final String apiPwd = "your api secret";
    final String appId = "{{appId}}";

    final String receiversName = "{{receiversName}}"; //Template name keyword for fuzzy query
    final String url = baseUrl.concat("/getListReceivers");
    HttpRequest request = HttpRequest.post(url);

    // currentTime
    final String datetime = String.valueOf(LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().getEpochSecond());
    // generate md5 key
    final String sign = SecureUtil.md5(apiKey.concat(apiPwd).concat(datetime));
    request.header(Header.CONNECTION, "Keep-Alive")
            .header(Header.CONTENT_TYPE, "application/json;charset=UTF-8")
            .header("Sign", sign)  //Signature with encryption
            .header("Timestamp", datetime) //Current system time stamp (second)
            .header("Api-Key", apiKey); //API KEY（Home-Developer options）

    final String params = JSONUtil.createObj()
            .set("appId", appId)
            .set("receiversName", receiversName)
            .toString();

    HttpResponse response = request.body(params).execute();
    if (response.isOk()) {
        String result = response.body();
        System.out.println(result);
    }
}

REQUEST

header('content-type:text/html;charset=utf8');

$apiKey = "your api key";
$apiSecret = "your api secret";
$appId = "{{appId}}";
$timeStamp = time();
$sign = md5($apiKey . $apiSecret . $timeStamp);

$receiversName = "{{receiversName}}";
$url = "https://api.itniotech.com/email/getListReceivers?appId=$appId&receiversName=$receiversName";

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_SSL_VERIFYPEER => 0,
    CURLOPT_SSL_VERIFYHOST => 0,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        "Content-Type: application/json;charset=UTF-8",
        "Sign: $sign",
        "Timestamp: $timeStamp",
        "Api-Key: $apiKey"
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

REQUEST

curl --location --request GET 'https://api.itniotech.com/email/getListReceivers'
--header 'Content-Type: application/json;charset=UTF-8'
--header 'Sign: {sign}'
--header 'Timestamp: {datetime}'
--header 'Api-Key: {apiKey}'
--data-raw '{"appId": "{{appId}}","receiversName": "{{receiversName}}"}'

REQUEST

import hashlib
import time
import requests
import json

base_url = "https://api.itniotech.com/email/getListReceivers"
api_key = "your api key"
api_pwd = "your api secret"
app_id = "{{appId}}"
receiversName = "{{receiversName}}"

timestamp = int(time.time())
s = "%s%s%s" % (api_key, api_pwd, str(timestamp))
sign = hashlib.md5(s.encode(encoding='UTF-8')).hexdigest()

headers = {
    'Content-Type': 'application/json;charset=utf-8',
    'Sign': sign,
    'Timestamp': str(timestamp),
    'Api-Key': api_key
}

params = {"appId": app_id, "receiversName": receiversName}
print(params)

rsp = requests.get(base_url, params, headers=headers)

if rsp.status_code == 200:
    data = json.loads(rsp.text)
    print(data)
 

RESPONSEEXAMPLE

{
    "status":"0",
    "reason":"success",
    "templateContent":[
        {
            "receiverId":1000001,
            "receiversName":"receiversName",
            "count":0,
            "createTime":"2023-03-20 09:34:58",
            "desc":"description"
        }
    ]
}