Fxiaoke Developer Manual Fxiaoke Developer Manual
  • APL Development Manual
  • PWC Development Manual
  • OpenAPI Documentation
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start

  • API Authorization

  • API Basics

  • OpenAPI

    • CRM Object API

    • CRM Common API

    • Address Book API

    • Other API

      • Task Todo API

      • Attendance Field Work API

      • Collaborative Approval API

      • Enterprise Connect API

      • Message API

        • Service Account Send Message
        • Revoke Message
        • Send Text Message
          • Send Compound Message
          • Send Image Message
        • Material Management API

        • Network Disk API

        • Marketing API

        • File Service

        • ERP API

        • BI API

        • Offline API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Send Text Message

    # Description

    Send a text message

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${cloud domain}/cgi/message/send?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    toUser List Yes Open platform employee ID list (message recipients, currently supports up to 500 users)
    msgType String Yes Message type, value: text
    text Map No Secondary object, text content details
    &ensp: content String Yes Text message content

    # Request Example

    {
       "toUser":[
          "TOUSER1",
          "TOUSER2"
       ],
       "msgType":"text",
       "text":{
          "content":"This is a text message"
       }
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Unique request ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int Error codes reference

    # Response Example

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # Notes

    • Do not use the message field in the response for logical judgment, as errorMessage may change;
    Revoke Message
    Send Compound Message

    ← Revoke Message Send Compound Message →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式