Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Livestreaming Task Management/ Starting a Virtual Human Intelligent Livestreaming Task

Starting a Virtual Human Intelligent Livestreaming Task

Function

Starts a virtual human intelligent livestreaming task.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

room_id

Yes

String

Script ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

video_config

No

VideoConfig object

Video output configuration.

play_policy

No

PlayPolicy object

Script playback policy.

output_urls

No

Array of strings

Details:

Address of the third-party livestreaming platform for RTMP video stream push.

NOTE:

The command REFRESH_OUTPUT_URL needs to be executed to refresh the URL during the livestream.

Constraints:

N/A

Options:

Currently, only one RTMP stream output address is supported.

Default value:

N/A

stream_keys

No

Array of strings

Details:

Stream key of the third-party livestreaming platform for RTMP video stream push, which corresponds to the ingest URL.

NOTE:

The command REFRESH_OUTPUT_URL needs to be executed to refresh the URL during the livestream.

Constraints:

N/A

Options:

Currently, only one RTMP stream output address is supported.

Default value:

N/A

interaction_callback_url

No

String

Details:

Interactive callback URL, including authentication information.

This parameter is mandatory when trigger.reply_mode is set to CALLBACK.

Constraints:

N/A

Options:

The value contains 0 to 2,048 characters.

Default value:

N/A

live_event_callback_config

No

LiveEventCallBackConfig object

Live event HTTPS callback notification configuration

rtc_callback_config

No

RTCLiveEventCallBackConfig object

RTC callback event configuration. Compatible processing. If the configuration is not carried, LIVE_PROGRESS is subscribed by default.

view_mode

No

String

Details:

Landscape or portrait mode.

Constraints:

You do not need to set this parameter. The value is determined by the resolution in video_config.

Options:

  • LANDSCAPE: landscape
  • VERTICAL: portrait

Default value:

VERTICAL

co_streamer_config

No

CoStreamerConfig object

Co-streamer configuration

Table 4 VideoConfig

Parameter

Mandatory

Type

Description

clip_mode

No

String

Details:

Clipping mode of the output video.

Constraints:

N/A

Options:

  • RESIZE: video scaling
  • CROP: video cropping

Default value:

RESIZE

codec

Yes

String

Details:

Video encoding format and video file format.

Constraints:

Only virtual avatar video production supports VP8 encoding.

Options:

  • H264: H.264 encoding, MP4 file output
  • VP8: VP8 encoding, WebM file output

Default value:

N/A

bitrate

Yes

Integer

Details:

Average output bitrate. Unit: kbit/s

Constraints:

  • Quality is prioritized for virtual avatar video production, which may exceed the preset bitrate.
  • Bitrate range for virtual avatar video production: [1000, 8000].

Default value:

N/A

Value range:

40-30000

width

Yes

Integer

Details:

Video width. Unit: pixel.

Constraints:

  • When clip_mode is set to RESIZE, the following resolutions are supported: 1920 x 1080, 1080 x 1920, 1280 x 720, 720 x 1280, 3840 x 2160, and 2160 x 3840. 4K is available only when the virtual avatar model supports 4K.
  • When clip_mode is set to CROP, (dx, dy) is the origin, and the width is the actual width of the reserved video.
  • Currently, only 1080 x 1920 and 1920 x 1080 are supported for virtual avatar livestreaming.

Default value:

N/A

Value range:

0-3840

height

Yes

Integer

Details:

Video height.

Unit: pixel.

Constraints:

  • When clip_mode is set to RESIZE, the following resolutions are supported: 1920 x 1080, 1080 x 1920, 1280 x 720, 720 x 1280, 3840 x 2160, and 2160 x 3840.
  • When clip_mode is set to CROP, (dx, dy) is the origin, and the height is the actual height of the reserved video.
  • Currently, only 1080 x 1920 and 1920 x 1080 are supported for virtual avatar livestreaming.

Default value:

N/A

Value range:

0-3840

frame_rate

No

String

Details:

Frame rate. Unit: FPS

Constraints:

The virtual avatar video frame rate is fixed at 25 FPS.

Default value:

25

is_subtitle_enable

No

Boolean

Details:

Whether the output video is subtitled.

Constraints:

Subtitles are not supported for virtual avatar livestreaming.

Options:

  • true: enable subtitling
  • false: disable subtitling

Default value:

false

subtitle_config

No

SubtitleConfig object

Subtitle configuration.

disable_system_watermark

No

Boolean

Details:

Indicates whether the system watermark is disabled for the output video.

Constraints:

Currently, this parameter takes effect only for trustlisted tenants.

Value range:

  • true
  • false

Default value:

false

dx

No

Integer

Details:

Horizontal coordinate of the pixel in the upper left corner of the cropped video.

NOTE:

The image layout size is based on the model resolution. For example, for a model with the resolution of 1920 x 1080, the value of dx ranges from 0 to 1920.

Constraints:

This parameter takes effect when clip_mode is set to CROP.

Default value:

N/A

Value range:

-1920-3840

dy

No

Integer

Details:

Vertical coordinate of the pixel in the upper left corner of the cropped video.

NOTE:

The image layout size is based on the model resolution. For example, for a model with the resolution of 1920 x 1080, the value of dy ranges from 0 to 1080.

Constraints:

This parameter takes effect when clip_mode is set to CROP.

Default value:

N/A

Value range:

-1920-3840

is_enable_super_resolution

No

Boolean

Details:

Whether super resolution is enabled for a video.

Constraints:

This parameter is available only for virtual avatar video production.

Options:

  • true: enable
  • false: do not enable

Default value:

false

Table 5 SubtitleConfig

Parameter

Mandatory

Type

Description

dx

No

Integer

Details:

Coordinates of the pixel in the lower left corner of the subtitle box.

Constraints:

N/A

Default value:

N/A

Value range:

0-1920

dy

No

Integer

Details:

Coordinates of the pixel in the lower left corner of the subtitle box.

Constraints:

N/A

Default value:

N/A

Value range:

0-1920

font_name

No

String

Details:

Font. The following fonts are supported:

  • HarmonyOS_Sans_SC_Black: HarmonyOS bold
  • HarmonyOS_Sans_SC_Regular: HarmonyOS normal
  • HarmonyOS_Sans_SC_Thin: HarmonyOS light

Constraints:

N/A

Options:

The value contains 0 to 64 characters.

Default value:

HarmonyOS_Sans_SC_Black

font_size

No

Integer

Details:

Font size. The interface value ranges from 0 to 120. The actual value range is 4 to 120. Use the actual value range.

Constraints:

N/A

Value range:

0-120

Default value:

54

h

No

Integer

Details:

Subtitle box height.

Constraints:

The parameter h is used to facilitate the calculation of the coordinates in the upper left corner of the subtitle box. This parameter is not used in the background.

Value range:

0-1920

w

No

Integer

Details:

Subtitle box width.

Constraints:

  • The subtitle box width is fixed at 80/ %of the screen width.
  • The parameter w is used to facilitate the calculation of the coordinates in the upper left corner of the subtitle box. This parameter is not used in the background.

Value range:

0-1920

Table 6 PlayPolicy

Parameter

Mandatory

Type

Description

repeat_count

No

Integer

Details:

Number of times that a script is played repeatedly.

  • –1: The playback is repeated until it is stopped manually.
  • 0: It is played only once.
  • n: It is played n + 1 times.

Constraints:

N/A

Value range:

-1-100

Default value:

0

auto_play_script

No

Boolean

Details:

Indicates whether to automatically play a script.

Constraints:

N/A

Options:

  • true: The script is automatically played after the task is initialized.
  • false: After the task is initialized, the script is not played until signal appears.

Default value:

true

play_mode

No

String

Details:

Virtual avatar control method.

Constraints:

N/A

Options:

TEXT: text control, that is, using TTS

AUDIO: speech control

NO_PRESET: no preset script, manual control

Default value:

TEXT

random_play_mode

No

String

Details:

Method of random script reading.

Constraints:

Random script reading starts from the second round of reading.

Options:

  • NONE: Random script reading is disabled.
  • SCENE: Random script reading based on scenes is enabled. Paragraphs in a scene are read in sequence.
  • SCRIPT_ITEM: Random script reading based on paragraphs is enabled. Script of each scene is read in sequence.
  • SCENE_AND_SCRIPT_ITEM: Script of both scenes and paragraphs is read randomly.

Default value:

SCRIPT_ITEM

need_independent_capture_client

No

Boolean

Details:

Whether an independent data collection device is required. This parameter is used when the client playback is separated from the command.

Constraints:

N/A

Options:

  • true: Devices are allocated to RTC users CAPTURE and PLAYER.
  • false: Devices are allocated only to the RTC user PLAYER.

Default value:

false

Table 7 LiveEventCallBackConfig

Parameter

Mandatory

Type

Description

live_event_type_callback_url

No

String

Details:

Live event callback address, which is an HTTPS address.

Constraints:

N/A

Options:

The value contains 0 to 2,048 characters.

Default value:

N/A

auth_type

No

String

Details:

Authentication type.

Constraints:

N/A

Options:

  • NONE: The URL contains authentication.
  • MSS_A: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are added to the URL.

    Value format: hwSecret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)&hwTime=hex(timestamp)

  • MSS_A_HEAD: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are placed in Head.

    Value format: x-hw-mss-secret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)

    x-hw-mss-time=hex(timestamp)

  • MEITUAN_DEFAULT: This parameter is used only for Meituan's API callback.

Default value:

NONE

key

No

String

Details:

Key.

Constraints:

N/A

Options:

The value contains 0 to 32 characters.

Default value:

N/A

callback_event_type

No

Array of strings

Details:

Live event types in callbacks.

Constraints:

N/A

Options:

Currently, only the following options are supported:

  • SHOOT_SCRIPT_SWITCH: script paragraph switching event
  • RTMP_STREAM_STATE_CHANGE: RTMP link change callback event
  • REPLY_COMMAND_FINISH: Playback is complete.

The callback event structure is defined as follows:

  • event_type: event type
  • message: event description
    • The SHOOT_SCRIPT_SWITCH event callback is defined as follows:
      {
        "event_type":  "SHOOT_SCRIPT_SWITCH",
        "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"Product 1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"Paragraph 2\"}"
      }
    • The RTMP_STREAM_STATE_CHANGE callback is defined as follows:
      {
        "event_type":  "RTMP_STREAM_STATE_CHANGE",
        "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}"
      }

      The value of state can be CONNECTING, CONNECTED, DISCONNECTED, RECONNECTING, or END.

    • The REPLY_COMMAND_FINISH callback is defined as follows:
      {
        "event_type":  "REPLY_COMMAND_FINISH",
        "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}"
      }
Table 8 RTCLiveEventCallBackConfig

Parameter

Mandatory

Type

Description

rtc_callback_event_type

No

Array of strings

Live event types in RTC callbacks.

Currently, only the following options are supported:

  • LIVE_PROGRESS: live script progress notification
  • REPLY_COMMAND_FINISH: Playback is complete.

The callback event structure is defined as follows:

  • message_type: message type
  • data: message description
    • The LIVE_PROGRESS event callback is defined as follows:
      {
          "message_type": "live_progress_notify",
          "data": {
              "script_name": "Scene 1",
              "shoot_script_sequence_no": 2,
              "shoot_script_title": "Greeting",
              "offset": "247",
              "reply_id": "e87104f76d7546ce8a46ac6b04c49c3c"
          }
      }
    • The REPLY_COMMAND_FINISH callback is defined as follows:
      {
        "message_type": "reply_command_finish_notify",
        "data":"{
          "reply_id":"e87104f76d7546ce8a46ac6b04c49c3c"
        }"
      }
Table 9 CoStreamerConfig

Parameter

Mandatory

Type

Description

voice_config

No

VoiceConfig object

Voice configuration parameter.

streamer_action

No

String

Details:

Behavior of the streamer when the co-streamer speaks.

Constraints:

N/A

Options:

  • SILENCE: silent
  • VOLUME_DOWN: decreased volume

Default value:

N/A

Table 10 VoiceConfig

Parameter

Mandatory

Type

Description

voice_asset_id

Yes

String

Details:

Timbre asset ID, which can be queried from the asset library.

Constraints:

N/A

Options:

The value contains 1 to 256 characters.

Default value:

N/A

speed

No

Integer

Details:

Speaking speed. 50 indicates 0.5x speaking speed, 100 indicates normal speaking speed, and 200 indicates 2x speaking speed.

The value 100 indicates the normal speaking speed of an adult, which is about 150 words per minute.

Constraints:

N/A

Value range:

50-200

Default value:

100

pitch

No

Integer

Details:

Pitch.

Constraints:

N/A

Value range:

50-200

Default value:

100

volume

No

Integer

Details:

Volume.

Constraints:

N/A

Value range:

90-240

Default value:

140

Response Parameters

Status code: 202

Table 11 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.

Table 12 Response body parameters

Parameter

Type

Description

job_id

String

Livestreaming task ID.

rtc_room_info

RTCRoomInfoList object

RTC room information.

live_event_report_url

String

URL for reporting livestreaming events. Users report their own livestreaming events to this URL to trigger intelligent interaction and automatic reply.

live_event_callback_config

LiveEventCallBackConfig object

Live event HTTPS callback notification configuration

live_warning_info

Array of LiveWarningItem objects

List of livestreaming risk alarms.

Table 13 RTCRoomInfoList

Parameter

Type

Description

app_id

String

RTC application ID.

room_id

String

RTC room ID.

users

Array of RTCUserInfo objects

Information about users joining an RTC room.

Table 14 RTCUserInfo

Parameter

Type

Description

user_type

String

User type.

  • CAPTURE: Live assistant, which pushes video streams captured by cameras to RTC rooms.
  • ANIMATION: Visual control service, which pulls video streams from RTC rooms to generate motion data.
  • RENDER: Rendering service, which renders motion data into virtual human animations.
  • PLAYER: Common viewer, who can watch the original video stream or virtual human animation video stream.
  • INFERENCE_USER: Virtual human inference user, who receives audio streams from and pushes video streams to an RTC room.
  • END_USER: Device user, who receives video streams from and pushes audio streams to an RTC room.

user_id

String

RTC user ID.

signature

String

RTC authentication token.

ctime

Long

Validity period. Timestamp, in seconds.

Value range:

0-4294967295

Table 15 LiveEventCallBackConfig

Parameter

Type

Description

live_event_type_callback_url

String

Details:

Live event callback address, which is an HTTPS address.

Constraints:

N/A

Options:

The value contains 0 to 2,048 characters.

Default value:

N/A

auth_type

String

Details:

Authentication type.

Constraints:

N/A

Options:

  • NONE: The URL contains authentication.
  • MSS_A: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are added to the URL.

    Value format: hwSecret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)&hwTime=hex(timestamp)

  • MSS_A_HEAD: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are placed in Head.

    Value format: x-hw-mss-secret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)

    x-hw-mss-time=hex(timestamp)

  • MEITUAN_DEFAULT: This parameter is used only for Meituan's API callback.

Default value:

NONE

key

String

Details:

Key.

Constraints:

N/A

Options:

The value contains 0 to 32 characters.

Default value:

N/A

callback_event_type

Array of strings

Details:

Live event types in callbacks.

Constraints:

N/A

Options:

Currently, only the following options are supported:

  • SHOOT_SCRIPT_SWITCH: script paragraph switching event
  • RTMP_STREAM_STATE_CHANGE: RTMP link change callback event
  • REPLY_COMMAND_FINISH: Playback is complete.

The callback event structure is defined as follows:

  • event_type: event type
  • message: event description
    • The SHOOT_SCRIPT_SWITCH event callback is defined as follows:
      {
        "event_type":  "SHOOT_SCRIPT_SWITCH",
        "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"Product 1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"Paragraph 2\"}"
      }
    • The RTMP_STREAM_STATE_CHANGE callback is defined as follows:
      {
        "event_type":  "RTMP_STREAM_STATE_CHANGE",
        "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}"
      }

      The value of state can be CONNECTING, CONNECTED, DISCONNECTED, RECONNECTING, or END.

    • The REPLY_COMMAND_FINISH callback is defined as follows:
      {
        "event_type":  "REPLY_COMMAND_FINISH",
        "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}"
      }
Table 16 LiveWarningItem

Parameter

Type

Description

warning_type

String

Alarm type.

  • TOO_LESSS_SCRIPT_ITEMS: There are too few paragraphs (scripts).
  • TOO_SHORT_SCRIPT_TIME: The total duration of paragraphs (scripts) is too short.
  • TOO_LESS_DANMAKU_RULES: There are too few on-screen comment interaction rules.
  • RANDOM_PLAY_CLOSED: The random playback function is disabled.
  • ROTATION_MODEL_CLOSED: Streamer rotation is not configured.

Status code: 400

Table 17 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 18 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 19 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs

{
  "output_urls" : [ "rtmp://vfxpush.hwcloudvr.cn/live/lysa" ]
}

Example Responses

Status code: 202

Succeeded.

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}

Status code: 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 401

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code

Description

202

Succeeded.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

500

Internal service error.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback