# Fetch and map a single message by its SID

Operation ID: `connectors.twilioGetMessage`

Fetch and map a single message by its SID. Calls Twilio through the HealthCloud connector gateway.

## Public method

`getMessage`

Signature: `connectors.twilio.createClient(config).getMessage(body)`

Return type: `Promise<TwilioMessageResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/twilio/get-message`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`TwilioGetMessageRequest`](../models/TwilioGetMessageRequest.md) | Yes |  |  |  | No |  |

Request model: [`TwilioGetMessageRequest`](../models/TwilioGetMessageRequest.md)

## Request example

```json
{
  "account_sid": "example-account-sid",
  "auth_token": "example-access-token",
  "from_number": "example-from-number",
  "message_sid": "Your appointment is confirmed.",
  "messaging_service_sid": "example-messaging-service-sid",
  "mode": "sandbox"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`TwilioMessage`](../models/TwilioMessage.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "account_sid": "example-account-sid",
  "api_version": "example-api-version",
  "body": "Your appointment is confirmed.",
  "date_created": "example-date-created",
  "date_sent": "example-date-sent",
  "date_updated": "example-date-updated",
  "direction": "example-direction",
  "error_message": "Your appointment is confirmed.",
  "from_": "example-from-",
  "messaging_service_sid": "example-messaging-service-sid",
  "num_media": "example-num-media",
  "num_segments": "example-num-segments",
  "price_unit": "example-price-unit",
  "sid": "example-sid",
  "status": "example-status",
  "to": "patient@example.com",
  "uri": "example-uri"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { TwilioGetMessageRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "account_sid": "example-account-sid",
  "auth_token": "example-access-token",
  "from_number": "example-from-number",
  "message_sid": "Your appointment is confirmed.",
  "messaging_service_sid": "example-messaging-service-sid",
  "mode": "sandbox"
};

const result = await connectors.twilio.createClient(config).getMessage(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"account_sid":"example-account-sid","auth_token":"example-access-token","from_number":"example-from-number","message_sid":"Your appointment is confirmed.","messaging_service_sid":"example-messaging-service-sid","mode":"sandbox"}' \
  'https://dev-api-connectors.health.cloud/connectors/twilio/get-message'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
