---
title: "Set Service Type"
method: POST
path: "/fonenumbers/{fonenumber}/service"
tags: ["FoneNumbers", "fonenumbers"]
---

# Set Service Type

`POST /fonenumbers/{fonenumber}/service`

## Request

- Base URL: `https://api.fonestorm.com/v2`
- URL: `https://api.fonestorm.com/v2/fonenumbers/{fonenumber}/service`
- Auth: API key in header `token`

Set service type for a FoneNumber.

## Path parameters

- `fonenumber` string, required

## Request body

- object
  - `service_type` 'Conference' | 'Hangup' | 'Busy' | 'Reject', required: Service type. Allowed values are `Conference`, `Hangup`, `Busy`, `Reject`
  - `service_id` string: Service id

## Response `200`

Success

- object
  - `fonenumber` FoneNumber
    - `fonenumber` string: FoneNumber.
    - `label` string: Label for FoneNumber.
    - `group` string: Group for FoneNumber.
    - `type` string: FoneNumber type - 'Local' or 'Tollfree'.
    - `record_calls` string: Call recording configuration for FoneNumber.
    - `state` string: US State for FoneNumber.
    - `rate_center` string: Rate center for FoneNumber.
    - `is_active` string: Status of FoneNumber.
    - `message_options` object: SMS related properties.
      - `receive` object: Delivery service type used as the destination to receive messages.
        - `type` string: Configured service type.
        - `email` string: Email address if configured for email.
        - `device` string: FracTEL device if configured for device.
        - `forward` string: Telephone number if configured for forward.
        - `url` string: HTTP URL if configured for URL.
        - `url_method` string: HTTP URL method if configured for URL.
      - `receive_notify` object: Callback URL to notify when a message is received.
        - `type` string: Configured notification type.
        - `email` string: Email address if configured for email.
        - `url` string: HTTP URL.
        - `method` string: HTTP URL method.
      - `send_notify` object: Callback URL to notify when a message is sent.
        - `type` string: Configured notification type.
        - `email` string: Email address if configured for email.
        - `url` string: HTTP URL.
        - `method` string: HTTP URL method.
      - `messaging_enabled` string: SMS/MMS service is enabled for FoneNumber.
      - `messaging_campaign` string: Messaging Campaign ID for FoneNumber.
    - `call_options` object: Voice related properties.
      - `receive` object: Voice Service type related properties.
        - `type` string: Delivery service type used for FoneNumber.
        - `value` string: Delivery service id used for FoneNumber.
      - `receive_notify` object: Callback URL to notify when a call is received.
        - `type` string: Configured notification type.
        - `email` string: Email address if configured for email.
        - `url` string: HTTP URL.
        - `method` string: HTTP URL method.
      - `send_notify` object: Callback URL to notify when a call is made.
        - `type` string: Configured notification type.
        - `email` string: Email address if configured for email.
        - `url` string: HTTP URL.
        - `method` string: HTTP URL method.
    - `fax_options` object: Fax related properties.
      - `receive_notify` object: Callback URL to notify when a fax is received.
        - `type` string: Configured notification type.
        - `email` string: Email address if configured for email.
        - `url` string: HTTP URL.
        - `method` string: HTTP URL method.
      - `send_notify` object: Callback URL to notify when a fax is sent.
        - `type` string: Configured notification type.
        - `email` string: Email address if configured for email.
        - `url` string: HTTP URL.
        - `method` string: HTTP URL method.
    - `e911location_options` object: E911Location related properties.
      - `location_id` string: ID of the saved location.
      - `e911location_id` string: ID of the saved E911Location.
      - `e911location_default` string: Value 'yes' if the location is the default E911Location.
      - `e911location_active` string: Status of the E911Location, 'yes', 'no', 'cancel' or 'test'.
    - `activation_date` string: Date and time of the FoneNumber activation
    - `cancellation_date` string: Date and time of the FoneNumber cancellation
    - `is_offnet` string: If FoneNumber is an Offnet phonenumber or not. 'yes' or 'no'
    - `offnet_services` object: Off-net services on the FoneNumber.
      - `call` string: Call service status if FoneNumber is offnet.
      - `message` string: Messaging service status if FoneNumber is offnet.
      - `e911location` string: E911Location service status if FoneNumber is offnet.
    - `port_out_pin` string: FoneNumber PortOut 4 digit security PIN.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail.md) · [All operations](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/llms.txt) · [OpenAPI document](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/revisions/9738d9b806d4?raw)
