API docs by Redocly

Signal Cli REST API (22.10.6)

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

Content type
application/json
{
  • "mode": "string",
  • "versions": [
    ],
  • "signal_cli": "string"
}

Configuration

Set the REST API configuration.

Set the REST API configuration.

Request Body schema: application/json
object or null

Responses

Request samples

Content type
application/json
{
  • "logging": {
    }
}

Response samples

Content type
application/json
{
  • "logging": {
    }
}

Search

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

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

Content type
application/json
[
  • {
    }
]

Messages

Send a signal message.

Send a signal message.number can be ommited if API is running w/ PYTHON_SIGNAL_CLI_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
mentions
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "message": "string",
  • "number": "string",
  • "base64_attachments": [
    ],
  • "mentions": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamps": {
    }
}

Send a signal message.

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

path Parameters
recipient
required
string
Request Body schema: application/json
message
string
number
string or null
base64_attachments
Array of strings

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "number": "string",
  • "base64_attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamps": {
    }
}

Groups

List all Signal Groups.

List all Signal Groups.

path Parameters
number
required
string

Registered Phone Number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 or null <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "members": [
    ],
  • "permissions": {
    },
  • "group_link": "disabled",
  • "admins": [
    ],
  • "description": "string",
  • "base64_avatar": "string",
  • "message_expiration_timer": 0
}

Response samples

Content type
application/json
{
  • "group_id": "string"
}

Update an existing Signal Group.

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

Content type
application/json
{
  • "group_link": "unchanged",
  • "add_admins": [
    ],
  • "add_members": [
    ]
}

Response samples

Content type
application/json
{
  • "blocked": true,
  • "id": "string",
  • "invite_link": "string",
  • "members": [
    ],
  • "name": "string",
  • "pending_invites": [
    ],
  • "pending_requests": [
    ],
  • "message_expiration_timer": 0,
  • "admins": [
    ],
  • "description": "string"
}

List a Signal Group.

List a Signal Group.

path Parameters
groupid
required
string

Group ID

number
required
string

Registered Phone Number

Responses

Response samples

Content type
application/json
{
  • "blocked": true,
  • "id": "string",
  • "invite_link": "string",
  • "members": [
    ],
  • "name": "string",
  • "pending_invites": [
    ],
  • "pending_requests": [
    ],
  • "message_expiration_timer": 0,
  • "admins": [
    ],
  • "description": "string"
}

Delete the specified Signal Group.

Delete a Signal Group.

path Parameters
groupid
required
string
number
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": 0,
  • "message": "string"
}

Join a Signal Group.

Join a Signal Group.

path Parameters
groupid
required
string

Group invite link like https://signal.group/#...

number
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": 0,
  • "message": "string"
}

Quit (leave) a Signal Group.

Quit (leave) a Signal Group.

path Parameters
groupid
required
string
number
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": 0,
  • "message": "string"
}

Reactions

Send a reaction.

Send a reaction.

path Parameters
number
required
string
Request Body schema: application/json
reaction
string
target_author
string
timestamp
integer <int32>
recipient
string
groupid
string or null
remove
boolean or null

Responses

Request samples

Content type
application/json
{
  • "reaction": "string",
  • "target_author": "string",
  • "timestamp": 0,
  • "recipient": "string",
  • "groupid": "string",
  • "remove": true
}

Response samples

Content type
application/json
{
  • "timestamps": {
    }
}

Delete a reaction.

Delete a reaction.

path Parameters
number
required
string
Request Body schema: application/json
recipient
string
target_author
string
timestamp
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "recipient": "string",
  • "target_author": "string",
  • "timestamp": 0
}

Response samples

Content type
application/json
{
  • "timestamps": {
    }
}

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 or null

Responses

Request samples

Content type
application/json
{
  • "captcha": "string",
  • "use_voice": true
}

Response samples

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

Content type
application/json
{
  • "pin": "string"
}

Response samples

Content type
application/json
{ }

Profiles

Update Profile.

Set your name and optional an avatar.

path Parameters
number
required
string
Request Body schema: application/json
name
string
family_name
string or null
base64_avatar
string or null
about
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "family_name": "string",
  • "base64_avatar": "string",
  • "about": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": 0,
  • "message": "string"
}

Swagger-Assets

path Parameters
__file_uri__
required
string

Responses