注册云信IM账号 - 即时通信

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

account_id

string

账号Id

必需

云信账号，请确保唯一性。

若涉及字母，传参时请一律小写处理。因此以返回结果中的 account_id 为准。

只允许字母、数字、半角下划线、@、半角点以及半角横线。

>= 1 字符<= 32 字符

token

string

账号登陆密钥

可选

云信账号对应的登录密钥 Token。

如果未指定，云信会自动生成 Token，并在创建账号成功后返回。

Token 如果没有更新，将永久有效。

<= 128 字符

configuration

object

账户配置项

可选

云信账号配置项。

enabled

boolean

账号禁用标记

可选

该账号是否可用。默认可用，若设为 false，则表示禁用该账号。- 禁用后账号无法登录，且该账号不能进行任何云信账号相关操作，调用相关接口会报错。- 被禁用的账号仍计入应用账号总数。

默认值:

true

p2p_chat_banned

boolean

单聊禁言标记

可选

单聊禁言标记。true：禁言。

默认值:

false

team_chat_banned

boolean

群聊禁言标记

可选

群聊禁言标记。true：禁言。

默认值:

false

chatroom_chat_banned

boolean

聊天室禁言标记

可选

聊天室禁言标记。true：禁言。

默认值:

false

qchat_chat_banned

boolean

圈组禁言标记

可选

圈组禁言标记。true：禁言。

默认值:

false

push_enabled_when_desktop_online

boolean

桌面端在线时是否关闭移动端推送

可选

当设备有登录记录时才支持设置，否则无法修改。

默认值:

false

user_information

object

必需

name

string

昵称

可选

需要通过反垃圾审核。

<= 64 字符

avatar

string

头像URL地址

可选

可设置为空字符串。
需要通过反垃圾审核。
上传头像图片请参考。

<= 1024 字符

示例值:

https://netease/xxx.png

sign

string

签名

可选

可设置为空字符串。
需要通过反垃圾审核。

email

string

邮箱地址

可选

需符合邮箱字符规则。
可设置为空字符串。
需要通过反垃圾审核。

<= 64 字符

示例值:

zhangsan@xx.com

birthday

string

生日

可选

可设置为空字符串。
需要通过反垃圾审核。

<= 16 字符

mobile

string

手机号码

可选

可设置为空字符串。
非中国大陆手机号码需要填写国家代码（如美国：+1-xxxxxxxxxx）或地区代码（如香港：+852-xxxxxxxx）。

<= 32 字符

gender

enum<integer>

性别

可选

枚举值:

012

默认值:

0

extension

string

扩展信息

可选

预留给开发者的扩展字段，建议封装成 JSON 格式，{key:value}。
长度上限 1024 个字符。
需要通过反垃圾审核。

<= 1024 字符

antispam_configuration

object

必需

enabled

boolean

必需

business_id_map

array [object {2}]

必需

示例

{
  "account_id": "48",
  "token": "aliqua exercitation occaecat Excepteur quis",
  "configuration": {
    "enabled": true,
    "p2p_chat_banned": false,
    "team_chat_banned": false,
    "chatroom_chat_banned": false,
    "qchat_chat_banned": false,
    "push_enabled_when_desktop_online": false
  },
  "user_information": {
    "name": "马示思难",
    "avatar": "http://dummyimage.com/100x100",
    "sign": "dolore reprehenderit laboris",
    "email": "l.bxyuulbt@qq.com",
    "birthday": "1974-12-27",
    "mobile": "13355645597",
    "gender": 0,
    "extension": "consequat ea"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://open.yunxinapi.com/im/v2/accounts' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_id": "48",
    "token": "aliqua exercitation occaecat Excepteur quis",
    "configuration": {
        "enabled": true,
        "p2p_chat_banned": false,
        "team_chat_banned": false,
        "chatroom_chat_banned": false,
        "qchat_chat_banned": false,
        "push_enabled_when_desktop_online": false
    },
    "user_information": {
        "name": "马示思难",
        "avatar": "http://dummyimage.com/100x100",
        "sign": "dolore reprehenderit laboris",
        "email": "l.bxyuulbt@qq.com",
        "birthday": "1974-12-27",
        "mobile": "13355645597",
        "gender": 0,
        "extension": "consequat ea"
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

account_id

string

账号Id

必需

云信账号，请确保唯一性。

若涉及字母，传参时请一律小写处理。因此以返回结果中的 account_id 为准。

只允许字母、数字、半角下划线、@、半角点以及半角横线。

>= 1 字符<= 32 字符

token

string

账号登陆密钥

可选

云信账号对应的登录密钥 Token。

如果未指定，云信会自动生成 Token，并在创建账号成功后返回。

Token 如果没有更新，将永久有效。

<= 128 字符

configuration

object

账户配置项

可选

云信账号配置项。

user_information

object

必需

示例

{
  "code": 200,
  "msg": "success.",
  "data": {
    "account_id": "6",
    "token": "fafsda232@623#*42",
    "configuration": {
      "enabled": false,
      "p2p_chat_banned": false,
      "team_chat_banned": false,
      "chatroom_chat_banned": true,
      "qchat_chat_banned": false,
      "push_enabled_when_desktop_online": true
    },
    "user_information": {
      "name": "张三",
      "avatar": "http://dummyimage.com/100x100",
      "sign": "in aute nulla Lorem",
      "email": "y.amene@qq.com",
      "birthday": "2008-11-02",
      "mobile": "13813888888",
      "gender": 1,
      "extension": "est eiusmod"
    }
  }
}

🟢200请求参数错误

🟢200服务器错误