Receive Char

Since 0.4.0 AGI Commands Found this useful? Upvote it. ×

Receives one character from channels supporting it.

Last reviewed 2026-04-14

receive char timeout
Description

Receives a character of text on a channel. Most channels do not support the reception of text. Returns the decimal value of the character if one is received, or 0 if the channel does not support text reception. Returns -1 only on error/hangup.

Arguments
  • timeout required - The maximum time to wait for input in milliseconds, or 0 for infinite. Most channels
User Notes

Know a tip or gotcha for this topic? Share it below and help others.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.

Moderated before publishing. Email never shown.

Related

VERBOSE

Logs a message to the asterisk verbose log.

AGI Commands agi
NOOP

Does nothing.

AGI Commands agi
HANGUP

Hangs up the specified channel. If no channel name is given, hangs up the current channel. Asterisk AGI command referenc...

AGI Commands agi
GOSUB

Cause the channel to execute the specified dialplan subroutine.

AGI Commands agi
EXEC

Executes application with given options. Returns whatever the application returns, or '-2' on failure to find applicatio...

AGI Commands agi
AGI Commands
ANSWER ASYNCAGI BREAK CHANNEL STATUS CONTROL STREAM FILE DATABASE DEL DATABASE DELTREE DATABASE GET DATABASE PUT EXEC GET DATA GET FULL VARIABLE GET OPTION GET VARIABLE GOSUB HANGUP NOOP RECEIVE CHAR RECEIVE TEXT RECORD FILE SAY ALPHA SAY DATE SAY DATETIME SAY DIGITS SAY NUMBER SAY PHONETIC SAY TIME SEND IMAGE SEND TEXT SET AUTOHANGUP SET CALLERID SET CONTEXT SET EXTENSION SET MUSIC SET PRIORITY SET VARIABLE SPEECH ACTIVATE GRAMMAR SPEECH CREATE SPEECH DEACTIVATE GRAMMAR SPEECH DESTROY SPEECH LOAD GRAMMAR SPEECH RECOGNIZE SPEECH SET SPEECH UNLOAD GRAMMAR STREAM FILE TDD MODE VERBOSE WAIT FOR DIGIT