Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/convFile/conversations/spaces/query |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-ConvFile.Space.Read-Group files space read permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it by calling the Get the access token of an internal app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | Yes | The unionId of the operator. Obtain it by calling the Query user details API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| openConversationId | String | Yes | The openConversationId of the chat. Obtain the value of openConversationId by calling the Create a group API. |
Request example
HTTPPOST /v1.0/convFile/conversations/spaces/query?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"openConversationId" : "cid9FTRQSLo+sKxxxx"
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client with a Token</p>
* @return Client
*
* @throws Exception
*/
public static com.aliyun.dingtalkconv_file_1_0.Client createClient() throws Exception {
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkconv_file_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkconv_file_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkconv_file_1_0.models.GetSpaceHeaders getSpaceHeaders = new com.aliyun.dingtalkconv_file_1_0.models.GetSpaceHeaders();
getSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkconv_file_1_0.models.GetSpaceRequest getSpaceRequest = new com.aliyun.dingtalkconv_file_1_0.models.GetSpaceRequest()
.setUnionId("chyxxxxx")
.setOpenConversationId("cid9FTRQSLo+sKxxxx");
try {
client.getSpaceWithOptions(getSpaceRequest, getSpaceHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains code and message attributes, which help locate the issue
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains code and message attributes, which help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
from typing import List
from alibabacloud_dingtalk.conv_file_1_0.client import Client as dingtalkconvFile_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.conv_file_1_0 import models as dingtalkconv_file__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkconvFile_1_0Client:
"""
Initialize the account Client with a Token
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkconvFile_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
get_space_headers = dingtalkconv_file__1__0_models.GetSpaceHeaders()
get_space_headers.x_acs_dingtalk_access_token = '<your access token>'
get_space_request = dingtalkconv_file__1__0_models.GetSpaceRequest(
union_id='chyxxxxx',
open_conversation_id='cid9FTRQSLo+sKxxxx'
)
try:
client.get_space_with_options(get_space_request, get_space_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes, which help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_space_headers = dingtalkconv_file__1__0_models.GetSpaceHeaders()
get_space_headers.x_acs_dingtalk_access_token = '<your access token>'
get_space_request = dingtalkconv_file__1__0_models.GetSpaceRequest(
union_id='chyxxxxx',
open_conversation_id='cid9FTRQSLo+sKxxxx'
)
try:
await client.get_space_with_options_async(get_space_request, get_space_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes, which help locate the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\GetSpaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\GetSpaceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with a Token
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$getSpaceHeaders = new GetSpaceHeaders([]);
$getSpaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getSpaceRequest = new GetSpaceRequest([
"unionId" => "chyxxxxx",
"openConversationId" => "cid9FTRQSLo+sKxxxx"
]);
try {
$client->getSpaceWithOptions($getSpaceRequest, $getSpaceHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// err contains code and message attributes, which help locate the issue
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"encoding/json"
"strings"
"fmt"
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkconvfile_1_0 "github.com/alibabacloud-go/dingtalk/convFile_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
// Description:
//
// Initialize the account Client with a Token
//
// @return Client
//
// @throws Exception
func CreateClient () (_result *dingtalkconvfile_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkconvfile_1_0.Client{}
_result, _err = dingtalkconvfile_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
getSpaceHeaders := &dingtalkconvfile_1_0.GetSpaceHeaders{}
getSpaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getSpaceRequest := &dingtalkconvfile_1_0.GetSpaceRequest{
UnionId: tea.String("chyxxxxx"),
OpenConversationId: tea.String("cid9FTRQSLo+sKxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetSpaceWithOptions(getSpaceRequest, getSpaceHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// err contains code and message attributes, which help locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkconvFile_1_0 = require('@alicloud/dingtalk/convFile_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');
class Client {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
static createClient() {
let config = new OpenApi.Config({ });
config.protocol = 'https';
config.regionId = 'central';
return new dingtalkconvFile_1_0.default(config);
}
static async main(args) {
let client = Client.createClient();
let getSpaceHeaders = new dingtalkconvFile_1_0.GetSpaceHeaders({ });
getSpaceHeaders.xAcsDingtalkAccessToken = '<your access token>';
let getSpaceRequest = new dingtalkconvFile_1_0.GetSpaceRequest({
unionId: 'chyxxxxx',
openConversationId: 'cid9FTRQSLo+sKxxxx',
});
try {
await client.getSpaceWithOptions(getSpaceRequest, getSpaceHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err contains code and message attributes, which help locate the issue
}
}
}
}
exports.Client = Client;
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/// <term><b>Description:</b></term>
/// <description>
/// <para>Initialize the account Client with a Token</para>
/// </description>
///
/// <returns>
/// Client
/// </returns>
///
/// <term><b>Exception:</b></term>
/// Exception
public static AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.GetSpaceHeaders getSpaceHeaders = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.GetSpaceHeaders();
getSpaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.GetSpaceRequest getSpaceRequest = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.GetSpaceRequest
{
UnionId = "chyxxxxx",
OpenConversationId = "cid9FTRQSLo+sKxxxx",
};
try
{
client.GetSpaceWithOptions(getSpaceRequest, getSpaceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes, which help locate the issue
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes, which help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| space | Object | The chat storage space information. |
| spaceId | String | The chat storage space ID. |
| corpId | String | The organization ID that the space belongs to. |
| createTime | String | The creation time of the group storage space, in ISO 8601 format. Example: 2022-07-29T14:55Z. |
| modifiedTime | String | The modification time of the group storage space, in ISO 8601 format. Example: 2022-07-29T14:55Z. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"space" : {
"spaceId" : "798xxxxx",
"corpId" : "ding1234xxxxx",
"createTime" : "2022-01-01T10:00:00Z",
"modifiedTime" : "2022-01-01T10:00:00Z"
}
}
Error codes
If an error occurs when calling this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | paramError | %s | Parameter error. |
| 400 | paramError.conversationId | %s | Parameter error - conversationId. |
| 403 | permissionDenied | %s | The user does not have permission to get the IM chat storage space. |
| 403 | acrossOrgAccessForbidden | %s | Cross-organization access is forbidden. |
| 404 | conversationNotExist | %s | The target chat does not exist. |
| 500 | systemError | %s | System error. |
| 500 | unknownError | Unknown Error | Unknown error. |