---
name: "eX_subscribe.h"
section: "3"
platform: "linux"
package: "libexosip2-dev"
version: "4.1.0-2.1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/eX_subscribe.h"
---

# eX\_subscribe.h(3)

eXosip subscribe request API

## NAME

eX\_subscribe.h - eXosip subscribe request API

## SYNOPSIS

`#include <osipparser2/osip_parser.h>`\
 `#include <time.h>`\

### Enumerations

enum **eXosip\_ss** { **EXOSIP\_SUBCRSTATE\_UNKNOWN**, **EXOSIP\_SUBCRSTATE\_PENDING**, **EXOSIP\_SUBCRSTATE\_ACTIVE**, **EXOSIP\_SUBCRSTATE\_TERMINATED** }\
 enum **eXosip\_ss\_reason** { **DEACTIVATED**, **PROBATION**, **REJECTED**, **TIMEOUT**, **GIVEUP**, **NORESOURCE** }\
 enum **eXosip\_ss\_status** { **EXOSIP\_NOTIFY\_UNKNOWN**, **EXOSIP\_NOTIFY\_PENDING**, **EXOSIP\_NOTIFY\_ONLINE**, **EXOSIP\_NOTIFY\_BUSY**, **EXOSIP\_NOTIFY\_BERIGHTBACK**, **EXOSIP\_NOTIFY\_AWAY**, **EXOSIP\_NOTIFY\_ONTHEPHONE**, **EXOSIP\_NOTIFY\_OUTTOLUNCH**, **EXOSIP\_NOTIFY\_CLOSED** }\

### Functions

int **eXosip\_subscribe\_build\_initial\_request** (struct eXosip\_t \*excontext, osip\_message\_t \*\*subscribe, const char \*to, const char \*from, const char \*route, const char \*event, int expires)\
 int **eXosip\_subscribe\_send\_initial\_request** (struct eXosip\_t \*excontext, osip\_message\_t \*subscribe)\
 int **eXosip\_subscribe\_build\_refresh\_request** (struct eXosip\_t \*excontext, int did, osip\_message\_t \*\*sub)\
 int **eXosip\_subscribe\_send\_refresh\_request** (struct eXosip\_t \*excontext, int did, osip\_message\_t \*sub)\
 int **eXosip\_subscribe\_remove** (struct eXosip\_t \*excontext, int did)\
 int **eXosip\_insubscription\_build\_answer** (struct eXosip\_t \*excontext, int tid, int status, osip\_message\_t \*\*answer)\
 int **eXosip\_insubscription\_send\_answer** (struct eXosip\_t \*excontext, int tid, int status, osip\_message\_t \*answer)\
 int **eXosip\_insubscription\_build\_request** (struct eXosip\_t \*excontext, int did, const char \*method, osip\_message\_t \*\*request)\
 int **eXosip\_insubscription\_build\_notify** (struct eXosip\_t \*excontext, int did, int subscription\_status, int subscription\_reason, osip\_message\_t \*\*request)\
 int **eXosip\_insubscription\_send\_request** (struct eXosip\_t \*excontext, int did, osip\_message\_t \*request)\
 int **eXosip\_insubscription\_remove** (struct eXosip\_t \*excontext, int did)\

## Detailed Description

eXosip subscribe request API

This file provide the API needed to control SUBSCRIBE requests. You can use it to:

- •

  build SUBSCRIBE requests.

- •

  send SUBSCRIBE requests.

- •

  build SUBSCRIBE answers.

- •

  send SUBSCRIBE answers.

## Author

Generated automatically by Doxygen for libeXosip2 from the source code.