IRC API
A simplified RESTful API for interacting with persistent Internet Relay Chat connections.
Networks ¶
A “network” represents a user-defined connection to IRC. Each network has one or more IRC servers to which the API will connect.
Networks collection ¶
List existing networksGET/networks
Example URI
GET /networks
Response
200Headers
Content-Type: application/jsonNetwork information ¶
Get network informationGET/networks/{network}
Example URI
GET /networks/quakenet
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
Response
200Headers
Content-Type: application/jsonResponse
404If the specified network doesn’t exist
Update network informationPOST/networks/{network}
Example URI
POST /networks/quakenet
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
Response
204Response
400Response
404Delete networkDELETE/networks/{network}
Example URI
DELETE /networks/quakenet
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
Response
204Response
404Chats ¶
A chat represents either an IRC channel or a private message with another IRC user.
Chats collection ¶
List existing chatsGET/networks/{network}/chats
Example URI
GET /networks/quakenet/chats
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
Response
200Headers
Content-Type: application/jsonResponse
404Create new chatPOST/networks/{network}/chats
Example URI
POST /networks/quakenet/chats
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
Response
200Headers
Content-Type: application/jsonResponse
400Response
404Chat information ¶
Get chat informationGET/networks/{network}/chats/{chat}
Example URI
GET /networks/quakenet/chats/dmdirc
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
- chat
string(required) Example: dmdircThe name of the chat.
Response
200Headers
Content-Type: application/jsonResponse
404Delete chatDELETE/networks/{network}/chats/{chat}
Example URI
DELETE /networks/quakenet/chats/dmdirc
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
- chat
string(required) Example: dmdircThe name of the chat.
Response
204Response
404Chat messages ¶
Get chat messagesGET/networks/{network}/chats/{chat}/messages
Example URI
GET /networks/quakenet/chats/dmdirc/messages
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
- chat
string(required) Example: dmdircThe name of the chat.
Response
200Headers
Content-Type: application/jsonResponse
404Send chat messagePOST/networks/{network}/chats/{chat}/messages
Example URI
POST /networks/quakenet/chats/dmdirc/messages
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
- chat
string(required) Example: dmdircThe name of the chat.
Response
200Headers
Content-Type: application/jsonResponse
400Response
404Chat users ¶
List chat usersGET/networks/{network}/chats/{chat}/users
Example URI
GET /networks/quakenet/chats/dmdirc/users
URI Parameters
- network
string(required) Example: quakenetThe name of the network.
- chat
string(required) Example: dmdircThe name of the chat.
Response
200Headers
Content-Type: application/jsonResponse
404