GLglobalrelay
Conversation

POST a single conversation message

Represents conversation between several parties, eg.g IM messaging or threaded conversation over time

post/v2/conversations

Request

Headers

X-SubTypestring required

Request body

Example request

{
  "requestInfo": {
    "requestId": "c1319852-5367-5958-9aee-98fffdc22490"
  },
  "conversationOverview": {
    "conversationId": "c1319852-5367-5958-9aee-98fffdc22491",
    "initiatorName": "Joe",
    "initiatorEmail": "joe@example.com",
    "title": "Meeting using Personal Meeting ID",
    "description": "Joe's meeting",
    "initialParticipants": [
      {
        "displayName": "Joe Davies",
        "corporateEmail": "joe.davies@example.com",
        "phone": "44123456789",
        "companyName": "Corp Company",
        "userType": "initiator",
        "identityType": "External"
      }
    ],
    "conversationProperties": [
      {
        "name": "IntID",
        "value": "0-123-456-789"
      }
    ],
    "subjectOverride": "MS Teams for Green team channel"
  },
  "conversationEvents": [
    {
      "eventTime": 1742900713000,
      "eventType": "Message",
      "participants": [
        {
          "displayName": "Joe Davies",
          "corporateEmail": "joe.davies@example.com",
          "phone": "44123456789",
          "companyName": "Corp Company",
          "userType": "initiator",
          "identityType": "External"
        }
      ],
      "content": {
        "textType": "plain",
        "message": "plain - What's the weather like? html - <p>What's the weather like?</p>"
      },
      "systemText": "system text",
      "files": [
        {
          "filename": "file.txt",
          "fileKey": "example-corp/all-meetings/file.txt",
          "fileHref": "http://example-corp.s3.amazonaws.com/file.txt",
          "transcribable": true
        }
      ]
    }
  ]
}

Response

Successful Operation

reconciliationIdstring required

Unique ID assigned by API service for each request which can be used for reconcilliation reporting

Example response

{
  "reconciliationId": "c1319852-5367-5958-9aee-98fffdc22493"
}

Changes

No recorded changes to this operation across all 1 revision of this API.