URL

POST

/api/sendImage

Sending API (Number)

Sending Image with or without caption to Phone Number (Number).
Use url if source image from online
Use caption message contains caption
Use asyncFlag and fill it with on to enable async request with message id as return

Request

Body Params application/json

key

string

required

number

string

required

Default:

caption

string

optional

url

string

required

isAsync

boolean

optional

isSchedule

boolean

optional

date

string

optional

Example

{
    "number": {{targetNumber}},
    "key": "XXX123XXX",
    "caption": "Hello World",
    "url": {{urlImageSample}}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.omnichannelmessenger.com/api/sendImage' \
--header 'Content-Type: application/json' \
--data-raw '{
    "number": "+62895802170387",
    "key": "XXX123XXX",
    "caption": "Hello World",
    "url": "https://www.sample-videos.com/img/Sample-jpg-image-100kb.jpg"
}'

Responses

🟢200Response

application/json

Body

object {0}

Example

{}

🟠403Key not valid

File Base64