---
title: "POST /rtm.start"
method: POST
path: "/rtm.start"
tags: ["rtm"]
---

# POST /rtm.start

`POST /rtm.start`

打开 RTM 连接会话

## Response `200`

request success

- RTMStart
  - `user` User, required
    - `id` string, required
    - `team_id` string, required
    - `email` string, email, required — 用户注册邮箱地址
    - `mobile` string, required — 用户注册手机号码
    - `name` string, required — 用户名
    - `full_name` string, required — 用户全名
    - `type` 'normal' | 'assistant' | 'hubot', required — 用户类型
    - `role` 'owner' | 'admin' | 'normal' | 'visitor', required — 用户在团队内的身份
    - `avatars` UserAvatar, required
      - `small` string, required
      - `medium` string, required
      - `large` string, required
    - `profile` UserProfile, required
      - `bio` string — 用户个人简介
      - `position` string — 用户个人资料
      - `skype` string — 用户 skype
    - `inactive` boolean, required — 用户是否已注销
    - `created` string, data-time, required — 用户加入时间
  - `ws_host` string, required — rtm 连接地址

## Other responses

- `default` — request fail

## Changes

- **2017-04-19** `fd4c7a508190` — 1 info
  - api tag `rtm` added
- **2017-04-18** `b37660ad33e5` — 1 info
  - api tag `rtm` removed
- **2017-04-04** `4751e3946b90` — 1 info
  - api tag `rtm` added
- **2017-03-13** `ef71aa691171` — 1 info
  - api tag `rtm` removed

[Change history](https://skmtc.dev/bearyinnovative/apis/beary-openapi/changes/rtm.start/post.md)

---

[API](https://skmtc.dev/bearyinnovative/apis/beary-openapi.md) · [All operations](https://skmtc.dev/bearyinnovative/apis/beary-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bearyinnovative/beary-openapi/revisions/6e42a0e2d730/schema)