---
name: "publishSocketMessage"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "1.2.6" }
platform:
  - "iOS"
  - "Android"
async: true
---

## publishSocketMessage

> [VERSION] DeviceKit >= 1.2.6

> [PLATFORM] iOS, Android

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

### Description

Send a message via the Socket message channel

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `message` | `Record<string, Record<string, any>>` | Yes | - | `1.2.6` | Message payload |
| `deviceId` | `string` | Yes | - | `1.2.6` | Device ID |
| `type` | `number` | Yes | - | `1.2.6` | LAN message type |
| `options` | `Record<string, Record<string, any>>` | Yes | - | `1.2.6` | Reserved flag for delivery logic configuration, extensible for features such as sending sounds or follow-up actions after delivery |
| `complete` | `() => void` | No | - | - | Callback executed when the API call completes (runs on both success and failure) |
| `success` | `(params: boolean) => void` | No | - | - | Callback invoked on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Callback invoked when the API call fails |

#### 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` | Extended error code |
| `errorMsg` | `string` | Extended error information |