> ## 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.

# Set up the quick entry of a single-chat bot

> Call this API to configure a single-chat bot's quick entry, including entry name, title, and PC and mobile redirect links, improving how quickly users can reach the bot.

Call this API to set up the quick entry for adding a single-chat bot. The configuration includes the entry name, title, PC redirect link, and mobile redirect link. This API is suitable for scenarios where an organization needs to quickly configure a bot entry to improve user reach.

## Request

### Basic information

| Field               | Value                                                                                            |
| ------------------- | ------------------------------------------------------------------------------------------------ |
| HTTP URL            | [https://api.dingtalk.io/v1.0/robot/plugins/set](https://api.dingtalk.io/v1.0/robot/plugins/set) |
| HTTP Method         | POST                                                                                             |
| Supported app types | appType-Internal app                                                                             |
| Permissions         | permission-Robot.SingleChat.ReadWrite-Single-chat bot management permission                      |

### Request headers

| Name                        | Type   | Required | Description                                                                                                                                                                         |
| --------------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential used to call this API. Obtain it by calling the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. |

### Request body

| Name           | Type   | Required | Description                                                                                                                                                       |
| -------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| robotCode      | String | No       | The code of the bot. See the `robotCode` section in the [Bot glossary](https://open.dingtalk.com/document/development/robot-overview#) to obtain the `robotCode`. |
| pluginInfoList | Array  | No       | The list of plugins.                                                                                                                                              |
| pcUrl          | String | No       | The redirect link of the chat quick entry on the PC client.                                                                                                       |
| mobileUrl      | String | No       | The redirect link of the quick entry on the mobile client.                                                                                                        |
| name           | String | Yes      | The name of the quick entry. Internationalization is supported, for example, `{"en_US":"test123","zh_CN":"测试123"}`.                                               |
| icon           | String | Yes      | The icon ID of the quick entry. Obtain the `mediaId` parameter by calling the [Upload media files](/open/development/upload-media-files#) API.                    |

### Request example

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" : "{\"en_US\":\"test123\"}",
    "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 {

    /**
     * Initialize the account Client with a Token
     * @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("{\"en_US\":\"test123\"}")
                .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 contains the 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 the code and message attributes, which help locate the issue
            }

        }        
    }
}
```

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:
        """
        Initialize the account Client with a Token
        @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='{"en_US":"test123"}',
            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 contains the code and message attributes, which help locate the issue
                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='{"en_US":"test123"}',
            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 contains the code and message attributes, which help locate the issue
                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 {

    /**
     * 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();
        $setRobotPluginHeaders = new SetRobotPluginHeaders([]);
        $setRobotPluginHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $pluginInfoList0 = new pluginInfoList([
            "pcUrl" => "https://www.dingtalk.io",
            "mobileUrl" => "https://www.dingtalk.io",
            "name" => "{\"en_US\":\"test123\"}",
            "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 contains the 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));
```

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"
)

/**
 * Initialize the account Client with a Token
 * @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("{\"en_US\":\"test123\"}"),
    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 contains the 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)
  }
}
```

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 {

  /**
   * Initialize the account Client with a Token
   * @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: "{\"en_US\":\"test123\"}",
      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 contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client with a Token
         * @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 = "{\"en_US\":\"test123\"}",
                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 contains the 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 the code and message attributes, which help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name   | Type    | Description                                                                      |
| ------ | ------- | -------------------------------------------------------------------------------- |
| result | Boolean | Indicates whether the quick entry of the single-chat bot is set up successfully. |

### Response body example

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

{
  "result" : true
}
```

### Error codes

If an error is returned when you call this API, find the solution in the [Global error codes](/open/development/server-api-error-codes-1) documentation based on the error message.

| HttpCode | Error code                          | Error message                                         | Description                                           |
| -------- | ----------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| 400      | param.illegal                       | Parameter error                                       | Parameter error                                       |
| 400      | invalidRequest.robotCodeNotMatch    | The app does not match the robotCode of the bound bot | The app does not match the robotCode of the bound bot |
| 400      | invalidRequest.robotNotExist        | The bot does not exist. Verify and add it             | The bot does not exist. Verify and add it             |
| 400      | invalidRequest.robotIsStop          | The bot has been disabled by the organization         | The bot has been disabled by the organization         |
| 400      | invalidRequest.exceededMaximumLimit | The maximum number of plugins has been exceeded       | The maximum number of plugins has been exceeded       |
| 400      | invalidRequest.jsonFormatErroj      | Invalid JSON format                                   | Invalid JSON format                                   |
| 500      | system.error                        | System error                                          | System error                                          |
| 500      | invalidRequest.pluginInstallFail    | Failed to install the plugin                          | Failed to install the plugin                          |