Signal Cli REST API (22.2.3)

Download OpenAPI specification:Download

License: MIT

This is the Signal Cli REST API documentation.

General

Lists general information about the API.

Returns the supported API versions.

Responses

Response samples

200

Content type

application/json

{ }

Search

Check if one or more phone numbers are registered with the Signal Service.

query Parameters

numbers

required

Array of strings

Numbers to check

Responses

Response samples

200
400

Content type

application/json

[{"number": "string",
"registered": true
}
]

Messages

Send a signal message.

Send a signal message.number can be ommited if API is running w/ SIGNAL_CLI_DBUS_REST_API_ACCOUNT

Request Body schema: application/json

recipients	Array of strings
message	string
number	string or null
base64_attachments	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"recipients": ["string"
],
"message": "string",
"number": "string",
"base64_attachments": ["string"
]
}

Response samples

201
400

Content type

application/json

{"timestamp": "string"
}

Send a signal message.

Send a signal message.number can be ommited if API is running w/ SIGNAL_CLI_DBUS_REST_API_ACCOUNT

path Parameters

recipient

required

string

Request Body schema: application/json

message	string
number	string or null
base64_attachments	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"message": "string",
"number": "string",
"base64_attachments": ["string"
]
}

Response samples

201
400

Content type

application/json

{"timestamp": "string"
}

Groups

List all Signal Groups.

path Parameters

number

required

string

Registered Phone Number

Responses

Response samples

200
400

Content type

application/json

[{"blocked": true,
"id": "string",
"internal_id": "string",
"invite_link": "string",
"members": ["string"
],
"name": "string",
"pending_invites": ["string"
],
"pending_requests": ["string"
],
"message_expiration_timer": 0,
"admins": ["string"
],
"description": "string"
}
]

Create a new Signal Group with the specified members.

Create a new Signal Group.

path Parameters

number

required

string

Request Body schema: application/json

name	string
members	Array of strings
	object or null
group_link	string Enum: "disabled" "enabled" "enabled-with-approval"
admins	Array of strings or null
description	string or null
base64_avatar	string or null
message_expiration_timer	integer <int32> Default: 0

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"members": ["string"
],
"permissions": {"add_members": "only-admins",
"edit_group": "only-admins"
},
"group_link": "disabled",
"admins": ["string"
],
"description": "string",
"base64_avatar": "string",
"message_expiration_timer": 0
}

Response samples

201
400

Content type

application/json

{"group_id": "string"
}

Update an existing Signal Group.

path Parameters

groupid required	string
number required	string

Request Body schema: application/json

group_link	string Enum: "unchanged" "disabled" "enabled" "enabled-with-approval"
add_admins	Array of strings or null
add_members	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"group_link": "unchanged",
"add_admins": ["string"
],
"add_members": ["string"
]
}

Response samples

200
400

Content type

application/json

{"blocked": true,
"id": "string",
"internal_id": "string",
"invite_link": "string",
"members": ["string"
],
"name": "string",
"pending_invites": ["string"
],
"pending_requests": ["string"
],
"message_expiration_timer": 0,
"admins": ["string"
],
"description": "string"
}

List a Signal Group.

path Parameters

groupid required	string Group ID
number required	string Registered Phone Number

Responses

Response samples

200
400

Content type

application/json

{"blocked": true,
"id": "string",
"internal_id": "string",
"invite_link": "string",
"members": ["string"
],
"name": "string",
"pending_invites": ["string"
],
"pending_requests": ["string"
],
"message_expiration_timer": 0,
"admins": ["string"
],
"description": "string"
}

Delete the specified Signal Group.

Delete a Signal Group.

path Parameters

groupid required	string
number required	string

Responses

Response samples

400

Content type

application/json

{"error": "string"
}

Join a Signal Group.

path Parameters

groupid required	string Get from invite link: https://signal.group/#`${groupid}`
number required	string

Responses

Response samples

400

Content type

application/json

{"error": "string"
}

Quit (leave) a Signal Group.

path Parameters

groupid required	string
number required	string

Responses

Response samples

400

Content type

application/json

{"error": "string"
}

Reactions

Delete a reaction.

path Parameters

number

required

string

Request Body schema: application/json

recipient	string
target_author	string
timestamp	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"recipient": "string",
"target_author": "string",
"timestamp": 0
}

Response samples

200
400

Content type

application/json

{"timestamp": "string"
}

Send a reaction.

Send a reaction. Request must include either recipient or recipients!

path Parameters

number

required

string

Request Body schema: application/json

reaction	string
target_author	string
timestamp	integer <int32>
recipients	Array of strings or null
recipient	string or null
remove	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"reaction": "string",
"target_author": "string",
"timestamp": 0,
"recipients": ["string"
],
"recipient": "string",
"remove": false
}

Response samples

201
400

Content type

application/json

{"timestamp": "string"
}

Devices

Register a phone number.

Register a phone number with the signal network.

path Parameters

number

required

string

Request Body schema: application/json

captcha	string or null
use_voice	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"captcha": "string",
"use_voice": false
}

Response samples

201
400

Content type

application/json

{ }

Verify a registered phone number.

Verify a registered phone number with the signal network.

path Parameters

token required	string
number required	string

Request Body schema: application/json

pin	string or null

Responses

Request samples

Payload

Content type

application/json

{"pin": "string"
}

Response samples

201
400

Content type

application/json

{ }

Swagger-Assets

path Parameters

__file_uri__

required

string