APIUSB / 平台接口 / 群发私信接口

群发私信接口

接口描述: 群发私信接口

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
chat_message_to_uuid字符串必须对话的uuid,多个使用英文,分隔
chat_message_data字符串必须-私信消息数据
chat_message_type枚举类型必须-范围:text/html/image/link/custom私信消息类型,text普通文本,html富文本,image图片,link链接,custom自定义
ext_data字符串可选-系统保留字段,扩展字段

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.item对象批量发送结果详情
data.item.other_uuid字符串接收私信的会员ID
data.item.chat_message_id字符串消息ID
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
chat_message_to_uuid 必须
chat_message_data 必须
chat_message_type 必须
ext_data 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "id": "2"
    },
    "msg": ""
}
curl https://api.apiusb.com/api/platform?s=Platform.ChatMessage.BulkSend&chat_message_to_uuid=12345678123456781234567812345678&chat_message_data=hello word&chat_message_type=text
{
    "ret": 200,
    "data": {
        "id": "2"
    },
    "msg": "",
    "debug": {
        "stack": [
            "[#1 - 0ms - PHALAPI_INIT]E:\\www\\api\\public\\api\\platform.php(51)",
            "[#2 - 0.8ms - PHALAPI_RESPONSE]E:\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(46)",
            "[#3 - 127.2ms - PHALAPI_FINISH]E:\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(74)"
        ],
        "sqls": [],
        "version": "2.15.0"
    }
}
$.ajax({
      url: "https://api.apiusb.com/api/platform",
      data: {s: "Platform.ChatMessage.BulkSend", chat_message_to_uuid: "12345678123456781234567812345678",chat_message_data: 'hello word', chat_message_type: 'text'},
      dataType: 'json',
      success: function (response, status, xhr) {
          console.log(response);
      }
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';

$client = PhalApiClient::create()
    ->withHost('https://api.apiusb.com/api/platform');$rs = $client->reset()
    ->withService('Platform.ChatMessage.BulkSend')
    ->withParams("chat_message_to_uuid", "12345678123456781234567812345678")
    ->withParams("chat_message_data", "hello word")
    ->withParams("chat_message_type", "text")
    ->withTimeout(3000)
    ->request();

// ret状态码,200表示成功
var_dump($rs->getRet());
// 业务数据
var_dump($rs->getData());
// 提示信息
var_dump($rs->getMsg());
#-*- coding:utf-8 -*-
import PhalApiClient

result = PhalApiClient.PhalApiClient('https://api.apiusb.com/api/platform', 'Platform.ChatMessage.BulkSendx', {'chat_message_to_uuid': '12345678123456781234567812345678','chat_message_data': 'hello word', 'chat_message_type': 'text'}, 3)
//FullscreenActivity.java
import net.phalapi.sdk.*;    /**
     * 网络操作相关的子线程
     */  
    Runnable networkTask = new Runnable() {  
      
        @Override  
        public void run() {  
            // TODO  
            // 在这里进行 http request.网络请求相关操作  
            
        	PhalApiClient client = PhalApiClient.create()
	       			    .withHost("https://api.apiusb.com/api/platform");
	       	
	       	PhalApiClientResponse response = client
	       			    .withService("Platform.ChatMessage.BulkSend")
	       			    .withParams("chat_message_to_uuid", "12345678123456781234567812345678")
	       			    .withParams("chat_message_data", "hello word")
	       			    .withParams("chat_message_type", "text")
	       			    .withTimeout(3000)
	       			    .request();

	   		String content = "";
	   		content += "ret=" + response.getRet() + "\n";
	   		if (response.getRet() == 200) {
				try {
					JSONObject data = new JSONObject(response.getData());
					content += "data.title=" + data.getString("title") + "\n";
					content += "data.content=" + data.getString("content") + "\n";
					content += "data.version=" + data.getString("version") + "\n";
				} catch (JSONException ex) {
					  
				}
	   		}
			content += "msg=" + response.getMsg() + "\n";
			
			Log.v("[PhalApiClientResponse]", content);
            
            
            Message msg = new Message();  
            Bundle data = new Bundle();  
            data.putString("value", content);  
            msg.setData(data);  
            handler.sendMessage(msg);  
        }  
    }; 
PhalApiClientResponse response = PhalApiClient.create()
  .withHost("https://api.apiusb.com/api/platform")
  .withService("Platform.ChatMessage.BulkSend")
  .withparamsList("chat_message_to_uuid", "12345678123456781234567812345678")
  .withparamsList("chat_message_data", "hello word")
  .withparamsList("chat_message_type", "text")
  .withTimeout(3000)
  .request();

Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
package main

import (
	"./PhalApiClient"
	"fmt"
	"net/url"
)
func main() {
	rs, err := PhalApiClient.NewRequest().
		WithHost(`https://api.apiusb.com/api/platform`).
		WithService("Platform.ChatMessage.BulkSend").
		WithParams(url.Values{}).
		Get()
	if err != nil {
		fmt.Println(err.Error())
	} else {
		fmt.Println("code------------------------", rs.Code)
		fmt.Println("data------------------------", rs.Data)
		fmt.Println("msg------------------------", rs.Msg)
	}
}
#import "AFNPhalApiClient.h"// 待POST的参数
NSDictionary *params = @{@"demo_key_1": @"your_key", @"demo_key_2": @"1.0"};

// 使用AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"https://api.apiusb.com/api/platform"] withService:@"Platform.ChatMessage.BulkSend"] withParams:params] requestWithFormDataBlock:^(id formData) {
	// 如需上传文件(图片等),请参照如下格式
    [formData appendPartWithFileData:UIImageJPEGRepresentation([UIImage imageNamed:@"head.JPG"], 1) name:@"file" fileName:@"image.jpg" mimeType:@"image/jpeg"];
} completeBlock:^(id resultObject) {
    PALog(@"resultObject: %@", resultObject);
} failureBlock:^(NSError *error) {
    PALog(@"error: %@", error);
}];

// 打印url查看
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2024-04-20 22:03:50