群画像 - 探马OpenAPI

请求参数

Query 参数

chatId

string

群聊ID

必需

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/api/v1/group/info?chatId=' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}'

返回响应

🟢200成功

application/json

Body

chatId

string

群ID

必需

name

string

群名

必需

ownerId

string

群主ID

必需

createTimeGroup

string

群创建时间

必需

groupTag

array [object {2}]

群标签

必需

id

number

标签ID

必需

name

string

标签名

必需

customerField

array [object {5}]

群字段

必需

id

number

字段ID

必需

name

string

字段名

必需

value

object

必需

字段的值。文本、日期类型为string，单选为选项id：number，多选为选项ID数组，地址为{"latitude": 123.123124, "longitude": 123.124124, //经纬度 "address": "xxxx", 详细地址 "locationAddress": “”//省市区}数组

type

string

字段类型

必需

fieldItems

object

可选

如果字段是单选、多选则会返回此字段

示例

{
    "chatId": "2",
    "name": "我的群聊",
    "ownerId": "24",
    "createTimeGroup": "1995-02-27 16:10:00",
    "groupTag": [
        {
            "id": 54,
            "name": "标签 1"
        }
    ],
    "customerField": [
        {
            "id": 43,
            "type": "text",
            "name": "文本字段",
            "value": "示例"
        },
        {
            "id": 80,
            "type": "date",
            "name": "日期字段",
            "value": "2023-11-01"
        },
        {
            "id": 54,
            "type": "radio",
            "name": "单选字段",
            "value": 123
        },
        {
            "id": 71,
            "type": "check box",
            "name": "多选字段",
            "value": [
                123,
                124,
                125
            ]
        },
        {
            "id": 71,
            "type": "multi text",
            "name": "多行文本字段",
            "value": "多行文本"
        },
        {
            "id": 71,
            "type": "location",
            "name": "地址字段",
            "value": {
                "latitude": 123.123124,
                "longitude": 123.124124,
                "address": "xxxx",
                "locationAddress": "北京市东城区"
            }
        }
    ]
}