---
name: "sendMqttMessage"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "3.3.0" }
  - { name: "@ray-js/ray", version: "1.4.21" }
platform:
  - "iOS"
  - "Android"
async: true
---

## sendMqttMessage

> [VERSION] DeviceKit >= 3.3.0 | @ray-js/ray >= 1.4.21

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Send a message via the MQTT channel.

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `message` | `Record<string, Record<string, any>>` | Yes | - | `3.3.0` | Message content |
| `deviceId` | `string` | Yes | - | `3.3.0` | device ID |
| `protocol` | `number` | Yes | - | `3.3.0` | Protocol number |
| `options` | `Record<string, Record<string, any>>` | Yes | - | `3.3.0` | Reserved marker for issuing-logic configuration; can be extended later (e.g., issuing sounds, follow-up actions after an operation). |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `(params: boolean) => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Basic usage

```tsx
import { device } from '@ray-js/ray'

const { sendMqttMessage } = device;

sendMqttMessage({
  message: {},
  deviceId: 'device_001',
  protocol: 0,
  options: {},
  success: (result) => {
    console.log('sendMqttMessage success', result);
  },
  fail: (error) => {
    console.log('sendMqttMessage fail', error.errorMsg);
  },
});
```