---
name: "publishThingModelMessage"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "2.0.7" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## publishThingModelMessage

> [VERSION] DeviceKit >= 2.0.7 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

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

### Description

Send a message via the Thing Model

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `devId` | `string` | Yes | - | `2.0.7` | Device ID |
| `type` | `number` | Yes | - | `2.0.7` | Type 0: Property, 1: Action, 2: Event |
| `payload` | `Record<string, any>` | Yes | - | `2.0.7` | Thing model delivery payload; the structure varies by type. Examples: Example:   type == property:      payload = {       "color":"green",          "brightness": 50       }   type == action:      payload = {         "actionCode": "testAction",         "inputParams": {           "inputParam1":"value1",           "inputParam2":"value2"         }      } |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => 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 { publishThingModelMessage } = device;

publishThingModelMessage({
  devId: 'device_001',
  type: 0,
  payload: {},
  success: () => {
    console.log('publishThingModelMessage success');
  },
  fail: (error) => {
    console.log('publishThingModelMessage fail', error.errorMsg);
  },
});
```