Messaging and integrations

Text messages (SMS)

Text messaging covers SMS, MMS and internal chat. Messages are grouped into threads (message sessions) per user. SMS numbers are the numbers that can send and receive texts.

In the Key Admin this is the Text messages (SMS) switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.

This feature holds sensitive data about callers and calls. Keep what you pull secure and only keep it as long as you need it.

List SMS blocks

GET/domains/~/smsblocks

Returns the SMS blocks on the account.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "id": "string",
    "requesting-number": "15555550123",
    "blocked-number": "15555550123",
    "domain": "string",
    "status": "active",
    "created-datetime": "2026-11-02 09:00:00",
    "last-modified-datetime": "2026-11-02 09:00:00"
  }
]

Response fields (7)

Field	Type	Notes
`id`	string	The item's ID.
`requesting-number`	string (e164)	Requesting number.
`blocked-number`	string (e164)	Blocked number.
`domain`	string	The account the item belongs to.
`status`	string	Current status. One of: `active`, `inactive` Default `active`
`created-datetime`	string (date-time)	Created (date and time).
`last-modified-datetime`	string (date-time)	Last modified (date and time).

Other responses: 400, 401, 404. See errors.

List SMS numbers

GET/domains/~/smsnumbers

Returns the SMS numbers on the account.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "number": "string",
    "application": "string",
    "domain": "string",
    "carrier": "string",
    "dest": "string",
    "mms-capable": "false",
    "group-mms-capable": "false"
  }
]

Response fields (7)

Field	Type	Notes
`number`	string
`application`	string
`domain`	string	The account the item belongs to. Max length 64
`carrier`	string
`dest`	string
`mms-capable`	boolean	Default `false`
`group-mms-capable`	boolean	Default `false`

Block a number from texting

POST/domains/~/smsblocks

Adds a number to the account's SMS block list.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Request body application/json

Field	Type	Notes
`requesting-number` required	string (e164)	Requesting number.
`blocked-number` required	string (e164)	Blocked number.
`status`	string	Current status. One of: `active`, `inactive` Default `active`

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "requesting-number": "15555550123",
    "blocked-number": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "requesting-number": "15555550123",
    "blocked-number": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "requesting-number": "15555550123",
        "blocked-number": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Other responses: 400, 401, 404. See errors.

Add an SMS number

POST/domains/~/smsnumbers

Turns on texting for a number and sets who receives its messages.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Request body application/json

Field	Type	Notes
`number` required	string
`application` required	string
`dest`	string
`carrier`	string

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "string",
    "application": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "number": "string",
    "application": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "number": "string",
        "application": "string"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Update an SMS block

PUT/domains/~/smsblocks/{id}

Changes an existing SMS block. Send the fields you want to set in the body.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`status`	string	Current status. One of: `active`, `inactive` Default `active`
`created-datetime`	string (date-time)	Created (date and time).
`last-modified-datetime`	string (date-time)	Last modified (date and time).

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active",
    "created-datetime": "2026-11-02 09:00:00",
    "last-modified-datetime": "2026-11-02 09:00:00"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "active",
    "created-datetime": "2026-11-02 09:00:00",
    "last-modified-datetime": "2026-11-02 09:00:00"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "status": "active",
        "created-datetime": "2026-11-02 09:00:00",
        "last-modified-datetime": "2026-11-02 09:00:00"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Other responses: 400, 401, 404. See errors.

Update an SMS number

PUT/domains/~/smsnumbers/{smsnumber}

Changes an existing SMS number. Send the fields you want to set in the body.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`smsnumber` required	path	string	The SMS number in E.164 digits.

Request body application/json

Field	Type	Notes
`application` required	string
`dest`	string
`carrier`	string

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers/15555550123" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers/15555550123", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "application": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers/15555550123",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "application": "string"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Remove an SMS block

DELETE/domains/~/smsblocks/{id}

Removes an SMS block. This can't be undone.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsblocks/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Other responses: 400, 401, 404. See errors.

Delete an SMS number

DELETE/domains/~/smsnumbers/{smsnumber}

Removes an SMS number. This can't be undone.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`smsnumber` required	path	string	The SMS number in E.164 digits.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers/15555550123" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers/15555550123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/smsnumbers/15555550123",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

List message threads for a user

GET/domains/~/users/{user}/messagesessions

Returns the message threads for one user.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "user": "1001",
    "domain": "string",
    "messagesession-remote": "string",
    "messagesession-muted": "string",
    "messagesession-id": "string",
    "messagesession-sms-number": "15555550123",
    "messagesession-last-datetime": "2026-11-02 09:00:00",
    "messagesession-start-datetime": "2026-11-02 09:00:00",
    "...": "15 more fields"
  }
]

Response fields (23)

Field	Type	Notes
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`messagesession-remote`	any
`messagesession-muted`	string
`messagesession-id`	string	ID of the messagesession.
`messagesession-sms-number`	any	Messagesession sms number.
`messagesession-last-datetime`	string	Messagesession last (date and time).
`messagesession-start-datetime`	string	Messagesession start (date and time).
`messagesession-last-message`	any
`messagesession-last-sender`	string
`messagesession-last-status`	string
`messagesession-last-email-reminder-datetime`	string	Messagesession last email reminder (date and time).
`messagesession-reciever-hostname`	string
`messagesession-queue-termination`	string
`messagesession-queue-status`	string
`messagesession-queue-session-id`	string	ID of the messagesession queue session.
`messagesession-agent-start-datetime`	string	Messagesession agent start (date and time).
`messagesession-last-type`	any
`messagesession-last-media-type`	string
`messagesession-last-media-size`	integer
`messagesession-type`	string
`messagesession-name`	string	Name of the messagesession.
`messagesession-participants`	string

Get a user's message thread

GET/domains/~/users/{user}/messagesessions/{messagesession}

Returns one of a user's message threads.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "user": "1001",
    "domain": "string",
    "messagesession-remote": "string",
    "messagesession-muted": "string",
    "messagesession-id": "string",
    "messagesession-sms-number": "15555550123",
    "messagesession-last-datetime": "2026-11-02 09:00:00",
    "messagesession-start-datetime": "2026-11-02 09:00:00",
    "...": "15 more fields"
  }
]

Response fields (23)

Field	Type	Notes
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`messagesession-remote`	any
`messagesession-muted`	string
`messagesession-id`	string	ID of the messagesession.
`messagesession-sms-number`	any	Messagesession sms number.
`messagesession-last-datetime`	string	Messagesession last (date and time).
`messagesession-start-datetime`	string	Messagesession start (date and time).
`messagesession-last-message`	any
`messagesession-last-sender`	string
`messagesession-last-status`	string
`messagesession-last-email-reminder-datetime`	string	Messagesession last email reminder (date and time).
`messagesession-reciever-hostname`	string
`messagesession-queue-termination`	string
`messagesession-queue-status`	string
`messagesession-queue-session-id`	string	ID of the messagesession queue session.
`messagesession-agent-start-datetime`	string	Messagesession agent start (date and time).
`messagesession-last-type`	any
`messagesession-last-media-type`	string
`messagesession-last-media-size`	integer
`messagesession-type`	string
`messagesession-name`	string	Name of the messagesession.
`messagesession-participants`	string

List messages in a thread

GET/domains/~/users/{user}/messagesessions/{messagesession}/messages

Returns the messages in one message thread.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "id": "string",
    "timestamp": "YYYY-MM-DDTHH:MM:SS.ssZ",
    "type": "string",
    "domain": "string",
    "direction": "string",
    "from-number": "15555550123",
    "from-user-id": "string",
    "from-video-attendee-id": "string",
    "...": "13 more fields"
  }
]

Response fields (21)

Field	Type	Notes
`id`	any	The item's ID.
`timestamp`	string	One of: `YYYY-MM-DDTHH:MM:SS.ssZ`
`type`	string	The kind of item.
`domain`	string	The account the item belongs to. Max length 64
`direction`	string
`from-number`	any	The number the message is sent from.
`from-user-id`	string	ID of the from user.
`from-video-attendee-id`	string	ID of the from video attendee.
`from-user-agent`	string
`dialed`	string
`text`	string
`terminating-user-id`	string	ID of the terminating user.
`terminating-number`	string	Terminating number.
`status`	string	Current status.
`video-instance-id`	string	ID of the video instance.
`media-type`	string
`media-size`	integer
`deleted-datetime`	any	Deleted (date and time).
`messagesession-reciever-hostname`	string
`messagesession-id`	string	ID of the messagesession.
`messagesession-participants`	string

List a user's SMS numbers

GET/domains/~/users/{user}/smsnumbers

Returns the numbers a user can send and receive texts from.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/smsnumbers" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/smsnumbers", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/smsnumbers",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "number": "string",
    "application": "string",
    "domain": "string",
    "carrier": "string",
    "dest": "string",
    "mms-capable": "false",
    "group-mms-capable": "false"
  }
]

Response fields (7)

Field	Type	Notes
`number`	string
`application`	string
`domain`	string	The account the item belongs to. Max length 64
`carrier`	string
`dest`	string
`mms-capable`	boolean	Default `false`
`group-mms-capable`	boolean	Default `false`

Count SMS numbers for a user

GET/domains/~/users/{user}/smsnumbers/count

Returns how many SMS numbers there are for one user, as {"total": n}.

Read Key Admin switch: Text messages (SMS), Read. Read only keys also work. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/smsnumbers/count" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/smsnumbers/count", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/smsnumbers/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

Other responses: 400, 401, 403, 404. See errors.

Send a chat message

POST/domains/~/users/{user}/messagesessions/{messagesession}/messages

Sends an internal chat message to another user on the account.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Send a group chat message

POST/domains/~/users/{user}/messagesessions/{messagesession}/messages

Sends an internal chat message to a group of users.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Send a group SMS

POST/domains/~/users/{user}/messagesessions/{messagesession}/messages

Sends a text message to everyone in a group thread.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Send a media chat message

POST/domains/~/users/{user}/messagesessions/{messagesession}/messages

Sends a picture or file in an internal chat.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Send an MMS in a thread

POST/domains/~/users/{user}/messagesessions/{messagesession}/messages

Sends a picture or file as a multimedia message.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Send an SMS in a thread

POST/domains/~/users/{user}/messagesessions/{messagesession}/messages

Sends a text message to the other party in a thread.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Change who is in a thread

PUT/domains/~/users/{user}/messagesessions/{messagesession}

Sets the participants of a group message thread.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`participants` required	string	The people in it, as a list of numbers or user IDs.

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "participants": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "participants": "string"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Rename a message thread

PUT/domains/~/users/{user}/messagesessions/{messagesession}

Changes one of a user's message threads.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Request body application/json

Field	Type	Notes
`session-name` required	string	Name of the thread.

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session-name": "Front Desk"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "session-name": "Front Desk"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "session-name": "Front Desk"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Leave a message thread

PUT/domains/~/users/{user}/messagesessions/{messagesession}/leave

Removes the user from a group message thread.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/leave" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/leave", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}/leave",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Delete a user's message thread

DELETE/domains/~/users/{user}/messagesessions/{messagesession}

Removes one of a user's message threads. This can't be undone.

Write Key Admin switch: Text messages (SMS), Write. Sensitive data

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`messagesession` required	path	string	The message thread ID.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messagesessions/{thread_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

List all message threads

GET/domains/~/messagesessions

Returns the text message threads for every user on the account.

Full access No feature switch covers this endpoint. It needs a Full access key.

Parameters

Name	In	Type	Notes
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/messagesessions" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/messagesessions", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/messagesessions",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "user": "1001",
    "domain": "string",
    "messagesession-remote": "string",
    "messagesession-muted": "string",
    "messagesession-id": "string",
    "messagesession-sms-number": "15555550123",
    "messagesession-last-datetime": "2026-11-02 09:00:00",
    "messagesession-start-datetime": "2026-11-02 09:00:00",
    "...": "15 more fields"
  }
]

Response fields (23)

Field	Type	Notes
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`messagesession-remote`	any
`messagesession-muted`	string
`messagesession-id`	string	ID of the messagesession.
`messagesession-sms-number`	any	Messagesession sms number.
`messagesession-last-datetime`	string	Messagesession last (date and time).
`messagesession-start-datetime`	string	Messagesession start (date and time).
`messagesession-last-message`	any
`messagesession-last-sender`	string
`messagesession-last-status`	string
`messagesession-last-email-reminder-datetime`	string	Messagesession last email reminder (date and time).
`messagesession-reciever-hostname`	string
`messagesession-queue-termination`	string
`messagesession-queue-status`	string
`messagesession-queue-session-id`	string	ID of the messagesession queue session.
`messagesession-agent-start-datetime`	string	Messagesession agent start (date and time).
`messagesession-last-type`	any
`messagesession-last-media-type`	string
`messagesession-last-media-size`	integer
`messagesession-type`	string
`messagesession-name`	string	Name of the messagesession.
`messagesession-participants`	string

Send a message

POST/domains/~/users/{user}/messages

Sends a text message from a user. A new thread is started if one doesn't exist.

Full access No feature switch covers this endpoint. It needs a Full access key.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.
`message` required	string	What happened, in words.
`destination` required	any	Where to send it: a number, extension or address.
`from-number`	string	The number the message is sent from.
`data`	string	File contents for media messages, as base64.
`mime-type`	any	The file's content type, like `image/jpeg`.
`size`	integer	File size in bytes.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messages" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "message": "Hello from NoodleVoice",
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/messages",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string",
        "message": "Hello from NoodleVoice",
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 200

{
  "id": "string",
  "timestamp": "YYYY-MM-DDTHH:MM:SS.ssZ",
  "type": "string",
  "domain": "string",
  "direction": "string",
  "from-number": "15555550123",
  "from-user-id": "string",
  "from-video-attendee-id": "string",
  "...": "13 more fields"
}

Response fields (21)

Field	Type	Notes
`id`	any	The item's ID.
`timestamp`	string	One of: `YYYY-MM-DDTHH:MM:SS.ssZ`
`type`	string	The kind of item.
`domain`	string	The account the item belongs to. Max length 64
`direction`	string
`from-number`	any	The number the message is sent from.
`from-user-id`	string	ID of the from user.
`from-video-attendee-id`	string	ID of the from video attendee.
`from-user-agent`	string
`dialed`	string
`text`	string
`terminating-user-id`	string	ID of the terminating user.
`terminating-number`	string	Terminating number.
`status`	string	Current status.
`video-instance-id`	string	ID of the video instance.
`media-type`	string
`media-size`	integer
`deleted-datetime`	any	Deleted (date and time).
`messagesession-reciever-hostname`	string
`messagesession-id`	string	ID of the messagesession.
`messagesession-participants`	string