S
Samva
S
Samva
DashboardAPISamva DocumentationQuickstart GuideAuthentication

API Reference

Email Management

Get MessageGet Message EventsGet Message StatusList MessagesSend Message

Conversation Management

Configuration

Analytics & Operations

OpenAPI Specification
API ReferenceMessages

Get Message

GET
/messages/:id

Authorization

apiKey
X-API-Key<token>

API key for authentication

In: header

Query Parameters

id*string
Formatuuid

Response Body

application/json

curl -X GET "https://samva.app/api/v1/messages/:id?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
  "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
  "parentMessageId": "6374729f-f337-435d-94aa-ff216bcb47eb",
  "fromParticipantId": "a1bbdb4a-0c08-4c77-87f5-1abe98ab3f40",
  "toParticipantIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "participantMetadata": "string",
  "channel": "sms",
  "direction": "outbound",
  "content": "string",
  "status": "pending",
  "statusHistory": "string",
  "provider": "string",
  "providerMessageId": "string",
  "providerStatus": "string",
  "providerResponse": "string",
  "providerCost": "string",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "sentAt": "2019-08-24T14:15:22Z",
  "deliveredAt": "2019-08-24T14:15:22Z",
  "readAt": "2019-08-24T14:15:22Z",
  "failedAt": "2019-08-24T14:15:22Z",
  "cost": "string",
  "currency": "string",
  "retryCount": -2147483648,
  "maxRetries": -2147483648,
  "lastError": "string",
  "errorDetails": "string",
  "workflowRunId": "string",
  "queueMessageId": "string",
  "deliveryAttempts": -2147483648,
  "lastAttemptAt": "2019-08-24T14:15:22Z",
  "tags": [
    "string"
  ],
  "categories": [
    "string"
  ],
  "isTest": true,
  "isInternal": true,
  "isAutomated": true,
  "externalId": "string",
  "referenceId": "string",
  "apiKeyId": "37ba0474-c0bb-4910-bfb5-d6cebb614366",
  "httpMethod": "string",
  "apiRequestMetadata": "string",
  "apiResponseMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "fromParticipant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "displayName": "string",
    "type": "human",
    "channelIdentities": "string"
  },
  "toParticipants": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "displayName": "string",
      "type": "human",
      "channelIdentities": "string"
    }
  ],
  "emailMetadata": {
    "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
    "subject": "string",
    "fromEmail": "string",
    "fromName": "string",
    "toEmails": "string",
    "ccEmails": "string",
    "replyToEmail": "string",
    "threadPosition": -2147483648,
    "newContent": "string",
    "quotedContent": "string",
    "hasQuotedContent": true,
    "hasAttachments": -2147483648,
    "attachmentCount": -2147483648,
    "isAutoReply": true,
    "autoReplyReason": "string",
    "priority": "string",
    "receivedAt": "2019-08-24T14:15:22Z"
  },
  "whatsappMetadata": {
    "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
    "waMessageId": "string",
    "waConversationId": "string",
    "fromNumber": "string",
    "toNumber": "string",
    "messageType": "string",
    "templateName": "string",
    "templateLanguage": "string",
    "templateCategory": "string",
    "mediaUrl": "string",
    "mediaType": "string",
    "interactiveType": "string",
    "contextMessageId": "string",
    "conversationType": "string",
    "isBillable": true,
    "sentAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "readAt": "2019-08-24T14:15:22Z"
  }
}

List Email Threads

Previous Page

Get Message Events

Next Page

curl -X GET "https://samva.app/api/v1/messages/:id?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"