MediaCP Manual
    1. Getting Started
    2. Sales Questions
    3. Frequently Asked Questions
    4. Transcoder System Benchmarks
    5. Start your own streaming platform
    1. Product Licensing
    2. Change account currency
    1. Introduction
    2. Installation & Upgrade
      1. System Requirements
      2. Versions & Releases
      3. Installation
      4. Upgrading
      5. SSL Certificates
      6. Streaming Servers
        1. Nginx-Rtmp Video Server
        2. Wowza Streaming Engine
        3. Flussonic Media Server
        4. Video Feature Comparison
        5. Icecast 2 / Icecast KH
    3. Billing Integration
      1. Clientexec Integration Guide
      2. Blesta Integration Guide
      3. WHMCS Integration Guide
    4. Migrate from other software
      1. Migrate From AzuraCast
      2. Migrate From Centovacast
    5. Backup & Restoration
      1. Backup MediaCP
      2. Restore MediaCP
      3. Transfer to another server
    6. Administration
      1. Reset Admin Password
      2. Port 80 / 443 Proxy
      3. MediaCP System Commands
      4. Change MediaCP domain name
      5. Move media to another hard disk
      6. Secure your server
      7. Troubleshooting Login Errors
      8. Custom Facebook App
      9. Custom Web Service Configurations
      10. Admin Tools
    7. Scaling
      1. Nginx-Rtmp with CloudFront CDN
      2. Scale with Wowza and CloudFront CDN
    8. Troubleshooting
      1. Troubleshooting Wowza Streaming Engine
      2. FTP Troubleshooting
      3. MySQL Database Troubleshooting
      4. Reporting Troubleshooting
      5. Troubleshooting Liquidsoap AutoDJ
      6. Video Relay Troubleshooting
      7. Grant access to support team
    1. Introduction
    2. Administrators Dashboard
    3. System Configuration
      1. General
      2. Services
      3. Video Players
      4. Albums
      5. Email
      6. Plugins
      7. Statistics
      8. Backups
      9. Custom HTML
      10. Misc
    4. Customer Accounts
      1. Managing existing Customers
      2. Create a new Customer
      3. Deleting a Customer
      4. Login as another Customer
      5. Send email to Customer
      6. Reset Customer Password
    5. Reseller Accounts
      1. Create a Reseller Account
      2. Reseller Plans
    6. Media Services
      1. Creating a Media Service
      2. Deleting a Media Service
    7. Announcements
      1. Managing Announcements
      2. Creating Announcement
      3. Deleting Announcement
    8. Statistics
    9. Software Health
    10. Software Updates
    11. Email Templates
    12. API
    1. Introduction
    2. Audio Operation Manual
      1. Basics 101
      2. Station Overview
      3. Media Library
      4. Playlists
        1. General Rotation
        2. Jingles & Advertising
        3. Scheduling
        4. Repeat Protection
      5. Live DJ Connections
      6. Live Stream Recording
      7. DJ Manager
      8. Country Blocking
      9. Stream Proxy
      10. Stream Authentication
      11. Widgets & Links
      12. Reporting
    3. Video Operation Manual
      1. Basics 101
      2. Service Overview
      3. File Manager
      4. Scheduling
      5. Streaming to Your Service
      6. Stream Targets
      7. GeoIP Country Locking
      8. Widgets & Links
      9. Reporting
    4. Reseller Operations Manual
      1. Reseller Dashboard
      2. Customers
      3. Media Services
    1. Custom Domain Names
    2. Shoutcast 2 Admin Guide
    3. Wowza and Flussonic on same system
    4. Submit a feature request
    5. Wowza Custom Properties
    6. API Documentation
    1. DJ Priorities
    2. HTML5 Audio Player
    3. Broadcasting with AutoDJ
    4. Shoutcast 2 Premium
    5. Mount Points
    6. Managing Media Using FTP
    7. Shoutcast 2 Live Broadcasting
    1. Getting started with video streaming
    2. Live Streaming Overview
    3. TV Station Overview
    4. Ondemand Video Streaming
    5. GeoIP Country Locking
    6. VAST Advertising
    7. Relay & IP Camera
    8. Stream Recording
    9. Connecting your encoder
    10. Preparing Your Media Files
    11. Managing Media Using FTP
    12. Understanding Video Playlists
    13. Embedding player on your website
    14. Smooth Streaming and Content Transition
    15. Video Transcoding (Adaptive Bitrate Streaming)
    16. Image Logo or Watermark Overlay on Video Stream
    17. DVR Rewind
    18. Statistics
    19. Facebook Live Streaming
    20. Youtube Stream Publishing
    21. Twitch Stream Publishing
    22. Shoutcast 2 Stream Publishing
    23. Icecast Stream Publishing
    24. RTMP Stream Publishing
    1. Cloud Video Overview
    2. Admin Manual - Cloud Video
      1. Dashboard - A First Look
      2. Branding your platform
      3. Team & Staff Members
      4. Plans & Customers
      5. WHMCS Billing Provisioning Module
      6. Login to your cloud platform
      7. Activating VOD on Customer Plan
    3. User Manual - Cloud Video
      1. Login to your video platform
      2. First Look
      3. Creating a Channel
      4. Channel Overview
      5. Broadcasting
      6. Recording
      7. Fallback Video
      8. TV Channels - 24x7 UGC
      9. Video on Demand
      10. VOD Playlists
      11. Publishing
      12. Viewing Analytics
      13. Publish Zoom Meetings
      14. Advertising
      15. Restreaming IP Cameras
    4. Video Guide Series
    5. Streaming Best Practices
    6. Feature Comparison
    7. Roadmap & Release Notes
WHMCS Integration Guide

Last updated 5 months ago

Overview

Integration with WHMCS enables you to setup service plans to sell audio and video streaming services with automatic setup and provisioning of customer and streaming accounts.

Module Release Notes

Changelog is available at GitHub.

WHMCS Module

Install latest module

1. Make sure you have the latest version of MediaCP

2. Download the latest version of the MediaCP module for WHMCS

3. Extract the .zip file to your desktop

4. Connect to your WHMCS server via FTP and navigate to [WHMCS]/modules/servers

5. Drag and drop the mediacp folder from your desktop to your FTP client in order to upload the files.

6. You should now see the mediacp folder inside of your [WHMCS]/modules/servers path on the ftp server

Adding a server in WHMCS

  1. Login to WHMCS as an administrator and navigate to System Settings.
  2. Select Products & Services from the left menu then select Servers option.
  3. Select the + Add New Server button from the top of the page and fill out the form.
  4. Select Go to Advanced Mode
  5. Fill out the form according to the details below:
    • Name – Enter a label for this server.
    • Hostname – Enter the primary domain or subdomain name that MediaCP is installed on such as streaming.myserver.com
    • IP Address – enter the IP address of the MediaCP server, this will be used by WHMCS to validate access to the ports.
    • Server Status Address – This is used to provide network status and load to WHMCS. MediaCP provides a special URL for you to paste into the WHMCS Server configuration. To display Online status in WHMCS you should first ensure that MediaCP Port 80 is enabled.The format of the WHMCS Status Address is described below, replacing yourdomain.com:2020 with the MediaCP hostname and port and {api-key} with your MediaCP API Key.
      https://yourdomain.com:2020/whmcs-status/{api-key}/

      Example:

      https://demo.mediacp.net/whmcs-status/iMtTpHvVWMjMh8dZgn6n0Vqoq3aWyomKmp-KjMV9W5uY06eepH2Mxg==/
    • Module – Media Control Panel
    • Username – Administrator username, defaults to “admin”
    • Password – This field is not used.
    • Access Hash – Provide the MediaCP API Key into this field.
    • Secure – Check this box if HTTPS/SSL is configured with MediaCP (default ON).
    • Port – The primary port that MediaCP software uses. Default is 2020. Change only if you have configured an alternate port for MediaCP Web.
    • Name Servers – this information is not required by the MediaCP module.
  6. Press on the Save Changes button to finish.

Creating your first product

You are now ready to create and configure your first product for the MediaCP.

1. Navigate to Setup -> Products/Services. Then, click Create a new Product.

2. Select Shared Hosting Account and select a suitable product group and name and click Continue.

new-product

3. Select Module Settings tab and fill out base settings as preferred.

whmcs_module_settings

4. Press Save Changes

Additional

Configurable Options

You can let your customers build their own packages by setting Configurable Options.

  1. Navigate to Setup->Products/Services -> Configurable Options.
  2. Press Create a New Group
  3. Configure the Group Name and Assigned Products then press Add New Configurable Option.
  4. Refer to the table below to build your package options. It is important that the options are labelled correctly, you can choose to use either the Configurable Option or Alternatives for the Option names.
 Configurable OptionAlternativesOptionsDescription
 Media ServiceShoutcast
Shoutcast 2
Shoutcast 198
Icecast
Icecast 2
Icecast 2 KH
Icecast KH
Wowza Streaming Engine
Flash Media Service
Windows Media Services
 
 SourceAutoDJShoutcast Transcoder V1
Shoutcast Transcoder V2
Ices 0.4 (MP3)
Ices 2.0 (OGG)
Stream Transcoder V3
Alternatively, you can set this value to “Yes” and the module will automatically configure Shoutcast Transcoder V2.
Mountpoints Numerical ValueNumber of mountpoints that the Shoutcast or Icecast service will include.
Should be an integer.
AutoDJ Sources Numerical ValueNumber of AutoDJ sources that can be applied to mountpoints on Shoutcast and Icecast services.
Should be an integer.
Stream ProxyStream ProxyYes
No
Enable or disable the HTTP/HTTPS stream proxy on the account
Geo LockingGeolock
Country Locking
Yes
No
Allow or disallow geo country locking support on service
Source ReencodeAutoDJ ReencodeYes
No
ICES 0.4 ONLY
ConnectionsListeners
Viewers
Maximum Users
Maximum Listeners
Maximum Viewers
Numerical ValueEnter a value between 0 and 9999.
 BitrateMaximum Bitrate24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 400, 480, 560, 640, 720, 800, 920, 1024, 1280, 1536, 1792, 2048, 2560, 3072, 3584, 4096, 99999Enter only one of the values in the options column. This may also contain “Kbps” at the end of the option value.
 Disk UsageDisk
Quota
Disk Quota
MB, GB or TBSpecify a value including MB, GB or TB. For example: 100MB
 Data TransferTransfer
Bandwidth
MB, GB or TBSpecify a value including MB, GB or TB. For example: 100MB
 Historical ReportingReporting
Advanced Reporting
Yes / NoEnabled or Disable Historical Reporting capabilities. Standard Usage tab will be displayed in either case.
Stream AuthenticationStream Authentication
Listener Authentication
Stream Auth
Yes / NoIcecast & Icecast KH services ONLY
Enables or disables listener stream authentication feature..

Stream Publishing Options (Wowza, Flussonic, & Nginx-Rtmp) 

 Configurable OptionAlternativesOptionsDescription 
Stream PublishingStream TargetsYes / No Enables all stream targets
Stream Targets# Stream TargetsNumerical ValueEnter a value between 0 and 9999.
Facebook Publishing Yes / No 
Youtube Publishing Yes / No 
Periscope Publishing Yes / No 
Twitch Publishing Yes / No 
Shoutcast Publishing Yes / No 
Icecast Publishing Yes / No 
RTMP Publishing Yes / No 

Wowza Streaming Engine

 Configurable OptionAlternativesOptionsDescription
Wowza Media TypeService Type
Flash Media Service
Live Streaming
Live Streaming Low Latency
TV Station
Ondemand Streaming
Shoutcast/Icecast Relay
Live Camera Restream
 
 Live AuthenticationYes
No
Wowza Streaming Engine ONLY.
nDVR AddOnnDVR
nDVR Playback
Yes
No
Wowza Streaming Engine ONLY.
Transcoder ProfilesTranscoder Profiles160p
240p
360p
480p
576p
720p
1080p
2160p
Passthru
Comma delimited list of transcoder profiles.
Available with MediaCP 2.6+
For example:
240p
360p,576p
240p,360p,480p
480p,750p,1080p
Stream RecordingLive Stream RecordingYes
No
Wowza Streaming Engine ONLY.
 RTMPRTMP Support
RTMP Service
Yes
No
Enable RTMP/RTSP links for Shoutcast & Icecast Services ONLY.

Flussonic Media Server

 Configurable OptionAlternativesOptionsDescription 
 Service TypeService TypeLive Streaming
TV Station
Ondemand Streaming
 
Transcoder ProfilesTranscoder Profiles160p
240p
360p
480p
576p
720p
1080p
2160p
Passthru

Comma delimited list of transcoder profiles.

Available with MediaCP 2.6+

For example:
240p
360p,576p
240p,360p,480p
480p,750p,1080p

 nDVR AddOnnDVRYes  / No 

Custom Fields

Custom Fields allow customers to enter specific text values for some configurations.

Field NameField TypeValidationDescription
Publish NameText Box/^[a-zd_]{4,28}$/iAvailable for all Media Service Types.
Customer can specify desired Publish Name. If not available, the name will automatically be updated.
Check the Required Field and Show on Order Form.
Shoutcast URLText BoxWOWZA SERVICES ONLY.
Customer can specify their Shoutcast Restream URL or IPCAM Restream URL.
Alternate field names can be:
Icecast URL
Restream Address
IPCAM URL
IPCAM Address
Wowza VHostDrop DownWOWZA SERVICES ONLY.
Admin Only.
Required Field.
Format:
VHOST:IP:RTMP_PORT:
Example:
_defaultVHost_:110.110.110.1:1935

Allow customer to specify publish name

You can allow you customer to specify their preferred Publish Name by following these steps.

  1. Navigate to Setup->Products/Services. Then select an existing MediaCP product.
  2. Select the Custom Fields tab and Add New Custom Field with the following settings.
    • Field Name -> Publish Name
    • Field Type -> Text Box
    • Validation: /^[a-zd_]{4,28}$/i
    • Check Required Field
    • Check Show on Order Form

whmcs_custom_field

Email Templates

Audio Streaming (Shoutcast / Icecast)

You can use the following email templates for various services.

SHOUTCAST / ICECAST SERVICES

PLEASE READ THIS EMAIL IN FULL AND PRINT IT FOR YOUR RECORDS

Dear {$client_name},

Thank you for your order from us!

Your Shoutcast service has now been created and this email contains all the information you will need in order to begin using your services.

Hosting Control Panel
Address: https://{$service_server_hostname}:2020/
Username: {$service_username}
Password: {$service_password}

Media Service Information
Service Address: {$mediacp_host_address}
Service Port: {$mediacp_portbase}
Streaming Username: dj
Streaming Password: {$service_password}

Admin Address: http://{$service_domain}/admin
Username: admin
Password: {$service_password}

{foreach from=$service_config_options item=data}{$data.option}: {$data.value}
{/foreach}

How to stream to your new service
1. Download and install Winamp from www.winamp.com
2. Download and install Winamp Shoutcast DSP Plugin from http://shoutcast.com/BroadcastNow
3. Enter your Service IP, Port & Password into the Shoutcast DSP Plugin then press connect.

Thank you for choosing us.

{$signature}

Video Streaming

Please note, this template assumes you have configured the “Publish Name” custom field as the first custom field.

PLEASE READ THIS EMAIL IN FULL AND PRINT IT FOR YOUR RECORDS

Dear {$client_name},

Thank you for your order from us!

Your media service has now been created and this email contains all the information you will need in order to begin using your services.

Hosting Control Panel
Address: https://{$service_server_hostname}:2020/
Username: {$service_username}
Password: {$service_password}

Media Service Information
RTMP: rtmp://{$service_server_hostname}/{$service_custom_fields.0}/{$service_custom_fields.0}
RTSP: rtsp://{$service_server_hostname}/{$service_custom_fields.0}/{$service_custom_fields.0}

{foreach from=$service_config_options item=data}{$data.option}: {$data.value}
{/foreach}

Live Encoder Configuration
Server URL: rtmp://{$service_server_hostname}/{$service_custom_fields.0}
Stream Key: {$service_custom_fields.0}
Username: {$service_custom_fields.0}
Password: {$service_password}

Thank you for choosing us.

{$signature}

Troubleshooting

Request failed – Ensure firewall outgoing port is opened and ensure domain can be resolved.

The most common reason for this error is that your WHMCS server is unable to communicate with the MediaCP due to the outgoing port 2020 being blocked from your WHMCS server. Please review this Knowledgebase article for steps to resolve this WHMCS Request Failed & Transport Error.

Transport error – could not open socket

There is a connection problem between your WHMCS server and the MediaCP. Please review this Knowledgebase article for steps to resolve this WHMCS Request Failed & Transport Error.

Not supported with your version of MediaCP. Please upgrade MediaCP to version 2.9.11, 2.10.7 or newer.

If you are seeing this error when using the Sync button within WHMCS please review this Knowledgebase article for steps to resolve this WHMCS Not supported with your version of MediaCP.

Importing MediaCP accounts into WHMCS

MediaCP 2.9.11 and 2.10.7 introduce the ability to use WHMCS Server Sync tool. Please review this Knowledgebase article for steps to complete this Importing MediaCP accounts into WHMCS.

Table of Contents