Help Center/ Cognitive Engagement Center/ API Reference/ OMA Interface Reference/ Business Software Mall Connection Interfaces/ Calling Back Data by the Huawei IMC
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Calling Back Data by the Huawei IMC

Description

This interface is invoked by the Huawei IMC to call back data.

Method

POST

URI

https://Domain name/apiaccess/rest/oma/v1/imcopenapi/callback (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

reqBody

Object

No

-

1.1

data

String

No

Encrypted message body, which needs to be decrypted to obtain the message content. The sent data varies according to the event type.

1.2

signature

String

No

Message signature, which is used to verify whether the request comes from the IMC

Response Description

  • Status code: 200
    Table 2 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    schema

    Object

    No

    Returned message

    1.1

    code

    String

    No

    Return code. The value 200 indicates success.

    1.2

    message

    String

    No

    Return code description

    1.3

    data

    String

    No

    Encrypted message body, which needs to be decrypted to obtain the message content. The sent data varies according to the event type.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. Check whether related services are authorized.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Request header: none

Request parameters:

{
   "data":"XXXXX",
    "signature":"YYYYYY"
  }

Response parameters:

{
code: "200",
message: "success",
data:"XXXXX"
}