teleconsulting

7 .On_message

Sends a message within a teleconsultation. Beckn message action.

POST/teleconsulting/message

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

contextobjectRequired

context.domainstringRequired

context.countrystringRequired

context.citystringRequired

context.actionstringRequired

context.core_versionstringRequired

context.consumer_idstringRequired

context.consumer_uristringRequired

context.message_idstringRequired

context.timestampstringRequired

context.provider_idstringRequired

context.provider_uristringRequired

context.transaction_idstringRequired

messageobjectRequired

message.intentobjectRequired

message.intent.chatobjectRequired

message.intent.chat.senderobjectRequired

message.intent.chat.receiverobjectRequired

message.intent.chat.contentobjectRequired

message.intent.chat.timeobjectRequired

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

7 .On_message

curl --request POST \
  --url https://phrsbx.abdm.gov.in/teleconsulting/message \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {
    "domain": "nic2004:85111",
    "country": "IND",
    "city": "std:011",
    "action": "on_message",
    "core_version": "0.7.1",
    "consumer_id": "aarogyaSetu.eua",
    "consumer_uri": "https://aarogyasetu-sandbox.abdm.gov.in/aarogyasetu/api/v3/app/api/teleconsulting",
    "message_id": "<TXN_ID>",
    "timestamp": "2022-07-05T15:24:35.481906Z",
    "provider_id": "hspa-nha",
    "provider_uri": "http://hspasbx.abdm.gov.in/api/v1",
    "transaction_id": "<TXN_ID>"
  },
  "message": {
    "intent": {
      "chat": {
        "sender": {
          "person": {
            "name": "<NAME>",
            "gender": "M",
            "image": "image",
            "id": "santoshjagtap@sbx"
          }
        },
        "receiver": {
          "person": {
            "name": "<NAME>",
            "gender": "M",
            "image": "image hashed base64",
            "id": "<EMAIL>"
          }
        },
        "content": {
          "content_id": "<TXN_ID>",
          "content_value": "Base64 Encoded text",
          "content_type": "text"
        },
        "time": {
          "timestamp": "2022-10-03T11:32:01"
        }
      }
    }
  }
}'

{
  "message": {
    "ack": {
      "status": "ACK"
    }
  }
}

Generated from the schema. The values are placeholders, not a captured response.