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

# eXosip2\_subscribe(3)

eXosip2 SUBSCRIBE and outgoing subscriptions

## NAME

eXosip2\_subscribe - eXosip2 SUBSCRIBE and outgoing subscriptions

### 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)\

## Detailed Description

## Enumeration Type Documentation

### enum eXosip\_ss

Structure for subscription status

**Enumerator**

- *EXOSIP\_SUBCRSTATE\_UNKNOWN*

  *unknown subscription-state*

- *EXOSIP\_SUBCRSTATE\_PENDING*

  *pending subscription-state*

- *EXOSIP\_SUBCRSTATE\_ACTIVE*

  *active subscription-state*

- *EXOSIP\_SUBCRSTATE\_TERMINATED*

  *terminated subscription-state*

### enum eXosip\_ss\_reason

*Structure for subscription reason*

**Enumerator**

- *DEACTIVATED*

  *deactivated for subscription-state*

- *PROBATION*

  *probation for subscription-state*

- *REJECTED*

  *rejected for subscription-state*

- *TIMEOUT*

  *timeout for subscription-state*

- *GIVEUP*

  *giveup for subscription-state*

- *NORESOURCE*

  *noresource for subscription-state*

### enum eXosip\_ss\_status

*Structure for notification status*

**Enumerator**

- *EXOSIP\_NOTIFY\_UNKNOWN*

  *unknown state for subscription*

- *EXOSIP\_NOTIFY\_PENDING*

  *subscription not yet accepted*

- *EXOSIP\_NOTIFY\_ONLINE*

  *online status*

- *EXOSIP\_NOTIFY\_BUSY*

  *busy status*

- *EXOSIP\_NOTIFY\_BERIGHTBACK*

  *be right back status*

- *EXOSIP\_NOTIFY\_AWAY*

  *away status*

- *EXOSIP\_NOTIFY\_ONTHEPHONE*

  *on the phone status*

- *EXOSIP\_NOTIFY\_OUTTOLUNCH*

  *out to lunch status*

- *EXOSIP\_NOTIFY\_CLOSED*

  *closed status*

## Function Documentation

### 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)

*Build a default initial SUBSCRIBE request.*

**Parameters:**

*excontext eXosip\_t instance.* \
 *subscribe Pointer for the SIP request to build.* \
 *to SIP url for callee.* \
 *from SIP url for caller.* \
 *route Route header for SUBSCRIBE. (optional)* \
 *event Event header for SUBSCRIBE.* \
 *expires Expires header for SUBSCRIBE.*

### int eXosip\_subscribe\_send\_initial\_request (struct eXosip\_t \* excontext, osip\_message\_t \* subscribe)

*Send an initial SUBSCRIBE request.*

**Parameters:**

*excontext eXosip\_t instance.* \
 *subscribe SIP SUBSCRIBE message to send.*

### int eXosip\_subscribe\_build\_refresh\_request (struct eXosip\_t \* excontext, int did, osip\_message\_t \*\* sub)

*Build a default new SUBSCRIBE message.*

**Parameters:**

*excontext eXosip\_t instance.* \
 *did identifier of the subscription.* \
 *sub Pointer for the SIP request to build.*

### int eXosip\_subscribe\_send\_refresh\_request (struct eXosip\_t \* excontext, int did, osip\_message\_t \* sub)

*Send a new SUBSCRIBE request.*

**Parameters:**

*excontext eXosip\_t instance.* \
 *did identifier of the subscription.* \
 *sub SIP SUBSCRIBE message to send.*

### int eXosip\_subscribe\_remove (struct eXosip\_t \* excontext, int did)

*Remove outgoing subscription context.*

**Parameters:**

*excontext eXosip\_t instance.* \
 *did identifier of the subscription.*

## Author

*Generated automatically by Doxygen for libeXosip2 from the source code.*