> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 设置单聊机器人快捷入口

> 调用本接口可为单聊机器人配置快捷入口，包括入口名称、标题以及 PC 端与移动端跳转链接，提升用户触达效率。

调用本接口设置添加单聊机器人快捷入口。包含添加快捷入口名称、标题、PC端跳转链接和移动端跳转链接，适用于企业需快速配置机器人入口提升用户触达效率的场景。

## 请求

### 基本信息

| 字段          | 值                                                                                                |
| ----------- | ------------------------------------------------------------------------------------------------ |
| HTTP URL    | [https://api.dingtalk.io/v1.0/robot/plugins/set](https://api.dingtalk.io/v1.0/robot/plugins/set) |
| HTTP Method | POST                                                                                             |
| 支持的应用类型     | appType-企业内部应用                                                                                   |
| 权限要求        | permission-Robot.SingleChat.ReadWrite-单聊机器人使用管理权限                                                |

### 请求头

| 名称                          | 类型     | 是否必填 | 描述                                                                                                           |
| --------------------------- | ------ | ---- | ------------------------------------------------------------------------------------------------------------ |
| x-acs-dingtalk-access-token | String | 是    | 调用该接口的访问凭证，通过调用[获取企业内部应用的accessToken](/zh/open/development/obtain-the-access-token-of-an-internal-app#)接口获取。 |

### 请求体

| 名称             | 类型     | 是否必填 | 描述                                                                                                           |
| -------------- | ------ | ---- | ------------------------------------------------------------------------------------------------------------ |
| robotCode      | String | 否    | 机器人的编码，参见[机器人名词表-robotCode](https://open.dingtalk.com/document/development/robot-overview#)内容，获取`robotCode`。 |
| pluginInfoList | Array  | 否    | 插件列表。                                                                                                        |
| pcUrl          | String | 否    | pc端会话快捷入口跳转链接。                                                                                               |
| mobileUrl      | String | 否    | 手机端快捷入口跳转链接。                                                                                                 |
| name           | String | 是    | 快捷入口的名称，支持国际化形式，如`{"en_US":"test123","zh_CN":"测试123"}`。                                                      |
| icon           | String | 是    | 快捷入口的图标id，可通过调用[上传媒体文件](/zh/open/development/upload-media-files#)接口获取参数字段`mediaId`。                          |

### 请求示例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/robot/plugins/set HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xfhekjdbaafskjfXXXXX
Content-Type:application/json

{
  "robotCode" : "dingncjdnfpkNXXXXX",
  "pluginInfoList" : [ {
    "pcUrl" : "https://www.dingtalk.io",
    "mobileUrl" : "https://www.dingtalk.io",
    "name" : "{\"zh_CN\":\"测试123\"}",
    "icon" : "@lALPDtXaDkO3j7hgYA"
  } ]
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkrobot_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.dingtalkrobot_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkrobot_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkrobot_1_0.models.SetRobotPluginHeaders setRobotPluginHeaders = new com.aliyun.dingtalkrobot_1_0.models.SetRobotPluginHeaders();
        setRobotPluginHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrobot_1_0.models.SetRobotPluginRequest.SetRobotPluginRequestPluginInfoList pluginInfoList0 = new com.aliyun.dingtalkrobot_1_0.models.SetRobotPluginRequest.SetRobotPluginRequestPluginInfoList()
                .setPcUrl("https://www.dingtalk.io")
                .setMobileUrl("https://www.dingtalk.io")
                .setName("{\"zh_CN\":\"测试123\"}")
                .setIcon("@lALPDtXaDkO3j7hgYA");
        com.aliyun.dingtalkrobot_1_0.models.SetRobotPluginRequest setRobotPluginRequest = new com.aliyun.dingtalkrobot_1_0.models.SetRobotPluginRequest()
                .setRobotCode("dingncjdnfpkNXXXXX")
                .setPluginInfoList(java.util.Arrays.asList(
                    pluginInfoList0
                ));
        try {
            client.setRobotPluginWithOptions(setRobotPluginRequest, setRobotPluginHeaders, 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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        } 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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.robot_1_0.client import Client as dingtalkrobot_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.robot_1_0 import models as dingtalkrobot__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() -> dingtalkrobot_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkrobot_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        set_robot_plugin_headers = dingtalkrobot__1__0_models.SetRobotPluginHeaders()
        set_robot_plugin_headers.x_acs_dingtalk_access_token = '<your access token>'
        plugin_info_list_0 = dingtalkrobot__1__0_models.SetRobotPluginRequestPluginInfoList(
            pc_url='https://www.dingtalk.io',
            mobile_url='https://www.dingtalk.io',
            name='{"zh_CN":"测试123"}',
            icon='@lALPDtXaDkO3j7hgYA'
        )
        set_robot_plugin_request = dingtalkrobot__1__0_models.SetRobotPluginRequest(
            robot_code='dingncjdnfpkNXXXXX',
            plugin_info_list=[
                plugin_info_list_0
            ]
        )
        try:
            client.set_robot_plugin_with_options(set_robot_plugin_request, set_robot_plugin_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        set_robot_plugin_headers = dingtalkrobot__1__0_models.SetRobotPluginHeaders()
        set_robot_plugin_headers.x_acs_dingtalk_access_token = '<your access token>'
        plugin_info_list_0 = dingtalkrobot__1__0_models.SetRobotPluginRequestPluginInfoList(
            pc_url='https://www.dingtalk.io',
            mobile_url='https://www.dingtalk.io',
            name='{"zh_CN":"测试123"}',
            icon='@lALPDtXaDkO3j7hgYA'
        )
        set_robot_plugin_request = dingtalkrobot__1__0_models.SetRobotPluginRequest(
            robot_code='dingncjdnfpkNXXXXX',
            plugin_info_list=[
                plugin_info_list_0
            ]
        )
        try:
            await client.set_robot_plugin_with_options_async(set_robot_plugin_request, set_robot_plugin_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\SetRobotPluginHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\SetRobotPluginRequest\pluginInfoList;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\SetRobotPluginRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @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();
        $setRobotPluginHeaders = new SetRobotPluginHeaders([]);
        $setRobotPluginHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $pluginInfoList0 = new pluginInfoList([
            "pcUrl" => "https://www.dingtalk.io",
            "mobileUrl" => "https://www.dingtalk.io",
            "name" => "{\"zh_CN\":\"测试123\"}",
            "icon" => "@lALPDtXaDkO3j7hgYA"
        ]);
        $setRobotPluginRequest = new SetRobotPluginRequest([
            "robotCode" => "dingncjdnfpkNXXXXX",
            "pluginInfoList" => [
                $pluginInfoList0
            ]
        ]);
        try {
            $client->setRobotPluginWithOptions($setRobotPluginRequest, $setRobotPluginHeaders, 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 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkrobot_1_0  "github.com/alibabacloud-go/dingtalk/robot_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * 使用 Token 初始化账号Client
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkrobot_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkrobot_1_0.Client{}
  _result, _err = dingtalkrobot_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  setRobotPluginHeaders := &dingtalkrobot_1_0.SetRobotPluginHeaders{}
  setRobotPluginHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  pluginInfoList0 := &dingtalkrobot_1_0.SetRobotPluginRequestPluginInfoList{
    PcUrl: tea.String("https://www.dingtalk.io"),
    MobileUrl: tea.String("https://www.dingtalk.io"),
    Name: tea.String("{\"zh_CN\":\"测试123\"}"),
    Icon: tea.String("@lALPDtXaDkO3j7hgYA"),
  }
  setRobotPluginRequest := &dingtalkrobot_1_0.SetRobotPluginRequest{
    RobotCode: tea.String("dingncjdnfpkNXXXXX"),
    PluginInfoList: []*dingtalkrobot_1_0.SetRobotPluginRequestPluginInfoList{pluginInfoList0},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SetRobotPluginWithOptions(setRobotPluginRequest, setRobotPluginHeaders, &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 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkrobot_1_0, * as $dingtalkrobot_1_0 from '@alicloud/dingtalk/robot_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkrobot_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkrobot_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let setRobotPluginHeaders = new $dingtalkrobot_1_0.SetRobotPluginHeaders({ });
    setRobotPluginHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let pluginInfoList0 = new $dingtalkrobot_1_0.SetRobotPluginRequestPluginInfoList({
      pcUrl: "https://www.dingtalk.io",
      mobileUrl: "https://www.dingtalk.io",
      name: "{\"zh_CN\":\"测试123\"}",
      icon: "@lALPDtXaDkO3j7hgYA",
    });
    let setRobotPluginRequest = new $dingtalkrobot_1_0.SetRobotPluginRequest({
      robotCode: "dingncjdnfpkNXXXXX",
      pluginInfoList: [
        pluginInfoList0
      ],
    });
    try {
      await client.setRobotPluginWithOptions(setRobotPluginRequest, setRobotPluginHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 
    {

        /**
         * 使用 Token 初始化账号Client
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkrobot_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkrobot_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginHeaders setRobotPluginHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginHeaders();
            setRobotPluginHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginRequest.SetRobotPluginRequestPluginInfoList pluginInfoList0 = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginRequest.SetRobotPluginRequestPluginInfoList
            {
                PcUrl = "https://www.dingtalk.io",
                MobileUrl = "https://www.dingtalk.io",
                Name = "{\"zh_CN\":\"测试123\"}",
                Icon = "@lALPDtXaDkO3j7hgYA",
            };
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginRequest setRobotPluginRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginRequest
            {
                RobotCode = "dingncjdnfpkNXXXXX",
                PluginInfoList = new List<AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.SetRobotPluginRequest.SetRobotPluginRequestPluginInfoList>
                {
                    pluginInfoList0
                },
            };
            try
            {
                client.SetRobotPluginWithOptions(setRobotPluginRequest, setRobotPluginHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}
```

## 响应

### 响应体

| 名称     | 类型      | 描述               |
| ------ | ------- | ---------------- |
| result | Boolean | 是否成功设置单聊机器人快捷入口。 |

### 响应体示例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : true
}
```

### 错误码

若调用该接口报错，可根据错误信息在[全局错误码](/zh/open/development/server-api-error-codes-1)文档中查找解决方案。

| HttpCode | 错误码                                 | 错误信息                  | 说明                    |
| -------- | ----------------------------------- | --------------------- | --------------------- |
| 400      | param.illegal                       | 参数错误                  | 参数错误                  |
| 400      | invalidRequest.robotCodeNotMatch    | 应用与绑定的机器人robotCode不相符 | 应用与绑定的机器人robotCode不相符 |
| 400      | invalidRequest.robotNotExist        | 机器人不存在，请核实后添加         | 机器人不存在，请核实后添加         |
| 400      | invalidRequest.robotIsStop          | 机器人已经被组织停用            | 机器人已经被组织停用            |
| 400      | invalidRequest.exceededMaximumLimit | 超过插件最大个数限制            | 超过插件最大个数限制            |
| 400      | invalidRequest.jsonFormatErroj      | json格式错误              | json格式错误              |
| 500      | system.error                        | 系统错误                  | 系统错误                  |
| 500      | invalidRequest.pluginInstallFail    | 插件安装失败                | 插件安装失败                |
